diff --git a/vsphere/8.0.2.0/_sources/com.rst.txt b/vsphere/8.0.2.0/_sources/com.rst.txt new file mode 100644 index 00000000..f4442562 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.rst.txt @@ -0,0 +1,15 @@ +com package +=========== + +.. automodule:: com + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.networking.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.networking.rst.txt new file mode 100644 index 00000000..e8e1cced --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.networking.rst.txt @@ -0,0 +1,34 @@ +com.vmware.appliance.networking package +======================================= + +.. automodule:: com.vmware.appliance.networking + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.appliance.networking.dns\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.appliance.networking.dns_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.networking.firewall\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.appliance.networking.firewall_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.networking.interfaces\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.appliance.networking.interfaces_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.recovery.backup.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.recovery.backup.rst.txt new file mode 100644 index 00000000..fc978739 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.recovery.backup.rst.txt @@ -0,0 +1,26 @@ +com.vmware.appliance.recovery.backup package +============================================ + +.. automodule:: com.vmware.appliance.recovery.backup + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.appliance.recovery.backup.job\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.appliance.recovery.backup.job_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.recovery.backup.system\_name\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.recovery.backup.system_name_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.recovery.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.recovery.rst.txt new file mode 100644 index 00000000..692238f1 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.recovery.rst.txt @@ -0,0 +1,42 @@ +com.vmware.appliance.recovery package +===================================== + +.. automodule:: com.vmware.appliance.recovery + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.recovery.backup + +Submodules +---------- + +com.vmware.appliance.recovery.backup\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.appliance.recovery.backup_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.recovery.reconciliation\_client module +----------------------------------------------------------- + +.. automodule:: com.vmware.appliance.recovery.reconciliation_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.recovery.restore\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.appliance.recovery.restore_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.rst.txt new file mode 100644 index 00000000..cb5e4ebe --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.rst.txt @@ -0,0 +1,149 @@ +com.vmware.appliance package +============================ + +.. automodule:: com.vmware.appliance + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.networking + com.vmware.appliance.recovery + com.vmware.appliance.system + com.vmware.appliance.vcenter + +Submodules +---------- + +com.vmware.appliance.access\_client module +------------------------------------------ + +.. automodule:: com.vmware.appliance.access_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.health\_client module +------------------------------------------ + +.. automodule:: com.vmware.appliance.health_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.infraprofile\_client module +------------------------------------------------ + +.. automodule:: com.vmware.appliance.infraprofile_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.local\_accounts\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.appliance.local_accounts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.localaccounts\_client module +------------------------------------------------- + +.. automodule:: com.vmware.appliance.localaccounts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.logging\_client module +------------------------------------------- + +.. automodule:: com.vmware.appliance.logging_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.monitoring\_client module +---------------------------------------------- + +.. automodule:: com.vmware.appliance.monitoring_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.networking\_client module +---------------------------------------------- + +.. automodule:: com.vmware.appliance.networking_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.ntp\_client module +--------------------------------------- + +.. automodule:: com.vmware.appliance.ntp_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.recovery\_client module +-------------------------------------------- + +.. automodule:: com.vmware.appliance.recovery_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.shutdown\_client module +-------------------------------------------- + +.. automodule:: com.vmware.appliance.shutdown_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.support\_bundle\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.appliance.support_bundle_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.supportbundle\_client module +------------------------------------------------- + +.. automodule:: com.vmware.appliance.supportbundle_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.system\_client module +------------------------------------------ + +.. automodule:: com.vmware.appliance.system_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.update\_client module +------------------------------------------ + +.. automodule:: com.vmware.appliance.update_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vmon\_client module +---------------------------------------- + +.. automodule:: com.vmware.appliance.vmon_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.system.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.system.rst.txt new file mode 100644 index 00000000..0f2b04db --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.system.rst.txt @@ -0,0 +1,26 @@ +com.vmware.appliance.system package +=================================== + +.. automodule:: com.vmware.appliance.system + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.appliance.system.security\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.appliance.system.security_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.system.time\_client module +----------------------------------------------- + +.. automodule:: com.vmware.appliance.system.time_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.rst.txt new file mode 100644 index 00000000..e9f23275 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.rst.txt @@ -0,0 +1,15 @@ +com.vmware.appliance.vcenter package +==================================== + +.. automodule:: com.vmware.appliance.vcenter + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.vcenter.settings diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.rst.txt new file mode 100644 index 00000000..770d4aa7 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.rst.txt @@ -0,0 +1,26 @@ +com.vmware.appliance.vcenter.settings package +============================================= + +.. automodule:: com.vmware.appliance.vcenter.settings + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.vcenter.settings.v1 + +Submodules +---------- + +com.vmware.appliance.vcenter.settings.v1\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.rst.txt new file mode 100644 index 00000000..24c5330c --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.rst.txt @@ -0,0 +1,34 @@ +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package +==================================================================================== + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs\_client module +----------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha\_client module +---------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan\_client module +------------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.rst.txt new file mode 100644 index 00000000..e8f6c0b6 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.rst.txt @@ -0,0 +1,90 @@ +com.vmware.appliance.vcenter.settings.v1.config.components.inventory package +============================================================================ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster + +Submodules +---------- + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster\_client module +------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common\_client module +------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter\_client module +---------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore\_client module +--------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder\_client module +------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host\_client module +---------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network\_client module +------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool\_client module +------------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm\_client module +-------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.rst.txt new file mode 100644 index 00000000..d470ac92 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.components.rst.txt @@ -0,0 +1,74 @@ +com.vmware.appliance.vcenter.settings.v1.config.components package +================================================================== + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.vcenter.settings.v1.config.components.inventory + +Submodules +---------- + +com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt\_client module +---------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.authcommon\_client module +------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement\_client module +---------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventory\_client module +----------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization\_client module +------------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster\_client module +------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration\_client module +------------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.rst.txt new file mode 100644 index 00000000..cc328ffd --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.config.rst.txt @@ -0,0 +1,26 @@ +com.vmware.appliance.vcenter.settings.v1.config package +======================================================= + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.vcenter.settings.v1.config.components + +Submodules +---------- + +com.vmware.appliance.vcenter.settings.v1.config.components\_client module +------------------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config.components_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.rst.txt new file mode 100644 index 00000000..acd72858 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.appliance.vcenter.settings.v1.rst.txt @@ -0,0 +1,26 @@ +com.vmware.appliance.vcenter.settings.v1 package +================================================ + +.. automodule:: com.vmware.appliance.vcenter.settings.v1 + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance.vcenter.settings.v1.config + +Submodules +---------- + +com.vmware.appliance.vcenter.settings.v1.config\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.appliance.vcenter.settings.v1.config_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.cis.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.cis.rst.txt new file mode 100644 index 00000000..f676ca11 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.cis.rst.txt @@ -0,0 +1,26 @@ +com.vmware.cis package +====================== + +.. automodule:: com.vmware.cis + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.cis.tagging\_client module +------------------------------------- + +.. automodule:: com.vmware.cis.tagging_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.cis.task\_client module +---------------------------------- + +.. automodule:: com.vmware.cis.task_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.content.library.item.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.content.library.item.rst.txt new file mode 100644 index 00000000..4e7ec18f --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.content.library.item.rst.txt @@ -0,0 +1,26 @@ +com.vmware.content.library.item package +======================================= + +.. automodule:: com.vmware.content.library.item + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.content.library.item.downloadsession\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.content.library.item.downloadsession_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.content.library.item.updatesession\_client module +------------------------------------------------------------ + +.. automodule:: com.vmware.content.library.item.updatesession_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.content.library.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.content.library.rst.txt new file mode 100644 index 00000000..fc7a3ccf --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.content.library.rst.txt @@ -0,0 +1,26 @@ +com.vmware.content.library package +================================== + +.. automodule:: com.vmware.content.library + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.content.library.item + +Submodules +---------- + +com.vmware.content.library.item\_client module +---------------------------------------------- + +.. automodule:: com.vmware.content.library.item_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.content.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.content.rst.txt new file mode 100644 index 00000000..2b685b3a --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.content.rst.txt @@ -0,0 +1,27 @@ +com.vmware.content package +========================== + +.. automodule:: com.vmware.content + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.content.library + com.vmware.content.type + +Submodules +---------- + +com.vmware.content.library\_client module +----------------------------------------- + +.. automodule:: com.vmware.content.library_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.content.type.ovf.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.content.type.ovf.rst.txt new file mode 100644 index 00000000..55d1219f --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.content.type.ovf.rst.txt @@ -0,0 +1,18 @@ +com.vmware.content.type.ovf package +=================================== + +.. automodule:: com.vmware.content.type.ovf + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.content.type.ovf.policy\_client module +------------------------------------------------- + +.. automodule:: com.vmware.content.type.ovf.policy_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.content.type.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.content.type.rst.txt new file mode 100644 index 00000000..2b88df41 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.content.type.rst.txt @@ -0,0 +1,26 @@ +com.vmware.content.type package +=============================== + +.. automodule:: com.vmware.content.type + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.content.type.ovf + +Submodules +---------- + +com.vmware.content.type.ovf\_client module +------------------------------------------ + +.. automodule:: com.vmware.content.type.ovf_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.hcl.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.hcl.rst.txt new file mode 100644 index 00000000..8352df14 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.hcl.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.hcl package +========================== + +.. automodule:: com.vmware.esx.hcl + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.hcl.hosts\_client module +--------------------------------------- + +.. automodule:: com.vmware.esx.hcl.hosts_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.hosts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.hosts.rst.txt new file mode 100644 index 00000000..e27ff73e --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.hosts.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.hosts package +============================ + +.. automodule:: com.vmware.esx.hosts + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.hosts.software\_client module +-------------------------------------------- + +.. automodule:: com.vmware.esx.hosts.software_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.rst.txt new file mode 100644 index 00000000..054f87e0 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.rst.txt @@ -0,0 +1,44 @@ +com.vmware.esx package +====================== + +.. automodule:: com.vmware.esx + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.hcl + com.vmware.esx.hosts + com.vmware.esx.settings + +Submodules +---------- + +com.vmware.esx.hcl\_client module +--------------------------------- + +.. automodule:: com.vmware.esx.hcl_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.hosts\_client module +----------------------------------- + +.. automodule:: com.vmware.esx.hosts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings\_client module +-------------------------------------- + +.. automodule:: com.vmware.esx.settings_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.configuration.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.configuration.rst.txt new file mode 100644 index 00000000..30785742 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.configuration.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.clusters.configuration package +====================================================== + +.. automodule:: com.vmware.esx.settings.clusters.configuration + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.clusters.configuration.reports\_client module +--------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.configuration.reports_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.enablement.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.enablement.rst.txt new file mode 100644 index 00000000..a835fd33 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.enablement.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.clusters.enablement package +=================================================== + +.. automodule:: com.vmware.esx.settings.clusters.enablement + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.clusters.enablement.configuration\_client module +------------------------------------------------------------------------ + +.. automodule:: com.vmware.esx.settings.clusters.enablement.configuration_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.policies.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.policies.rst.txt new file mode 100644 index 00000000..67926602 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.policies.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.clusters.policies package +================================================= + +.. automodule:: com.vmware.esx.settings.clusters.policies + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.clusters.policies.apply\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.policies.apply_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.rst.txt new file mode 100644 index 00000000..e6603ce8 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.rst.txt @@ -0,0 +1,53 @@ +com.vmware.esx.settings.clusters package +======================================== + +.. automodule:: com.vmware.esx.settings.clusters + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.clusters.configuration + com.vmware.esx.settings.clusters.enablement + com.vmware.esx.settings.clusters.policies + com.vmware.esx.settings.clusters.software + +Submodules +---------- + +com.vmware.esx.settings.clusters.configuration\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.configuration_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.clusters.enablement\_client module +---------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.enablement_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.clusters.policies\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.policies_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.clusters.software\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.software_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.drafts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.drafts.rst.txt new file mode 100644 index 00000000..e543fc01 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.drafts.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.clusters.software.drafts package +======================================================== + +.. automodule:: com.vmware.esx.settings.clusters.software.drafts + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.clusters.software.drafts.software\_client module +------------------------------------------------------------------------ + +.. automodule:: com.vmware.esx.settings.clusters.software.drafts.software_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.rst.txt new file mode 100644 index 00000000..4eed1143 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.clusters.software.reports.hardware\_compatibility package +================================================================================= + +.. automodule:: com.vmware.esx.settings.clusters.software.reports.hardware_compatibility + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.clusters.software.reports.hardware\_compatibility.storage\_device\_overrides\_client module +------------------------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.reports.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.reports.rst.txt new file mode 100644 index 00000000..6ca2d4b5 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.reports.rst.txt @@ -0,0 +1,26 @@ +com.vmware.esx.settings.clusters.software.reports package +========================================================= + +.. automodule:: com.vmware.esx.settings.clusters.software.reports + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.clusters.software.reports.hardware_compatibility + +Submodules +---------- + +com.vmware.esx.settings.clusters.software.reports.hardware\_compatibility\_client module +---------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.rst.txt new file mode 100644 index 00000000..7816ee5d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.clusters.software.rst.txt @@ -0,0 +1,35 @@ +com.vmware.esx.settings.clusters.software package +================================================= + +.. automodule:: com.vmware.esx.settings.clusters.software + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.clusters.software.drafts + com.vmware.esx.settings.clusters.software.reports + +Submodules +---------- + +com.vmware.esx.settings.clusters.software.drafts\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.software.drafts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.clusters.software.reports\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters.software.reports_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.clusters.policies.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.clusters.policies.rst.txt new file mode 100644 index 00000000..7b572e8c --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.clusters.policies.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.defaults.clusters.policies package +========================================================== + +.. automodule:: com.vmware.esx.settings.defaults.clusters.policies + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.defaults.clusters.policies.apply\_client module +----------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults.clusters.policies.apply_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.clusters.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.clusters.rst.txt new file mode 100644 index 00000000..e410f914 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.clusters.rst.txt @@ -0,0 +1,26 @@ +com.vmware.esx.settings.defaults.clusters package +================================================= + +.. automodule:: com.vmware.esx.settings.defaults.clusters + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.defaults.clusters.policies + +Submodules +---------- + +com.vmware.esx.settings.defaults.clusters.policies\_client module +----------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults.clusters.policies_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.hosts.policies.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.hosts.policies.rst.txt new file mode 100644 index 00000000..36a55436 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.hosts.policies.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.defaults.hosts.policies package +======================================================= + +.. automodule:: com.vmware.esx.settings.defaults.hosts.policies + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.defaults.hosts.policies.apply\_client module +-------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults.hosts.policies.apply_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.hosts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.hosts.rst.txt new file mode 100644 index 00000000..ce0b47d0 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.hosts.rst.txt @@ -0,0 +1,26 @@ +com.vmware.esx.settings.defaults.hosts package +============================================== + +.. automodule:: com.vmware.esx.settings.defaults.hosts + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.defaults.hosts.policies + +Submodules +---------- + +com.vmware.esx.settings.defaults.hosts.policies\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults.hosts.policies_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.rst.txt new file mode 100644 index 00000000..3e2c750a --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.defaults.rst.txt @@ -0,0 +1,35 @@ +com.vmware.esx.settings.defaults package +======================================== + +.. automodule:: com.vmware.esx.settings.defaults + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.defaults.clusters + com.vmware.esx.settings.defaults.hosts + +Submodules +---------- + +com.vmware.esx.settings.defaults.clusters\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults.clusters_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.defaults.hosts\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults.hosts_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.depot_content.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.depot_content.rst.txt new file mode 100644 index 00000000..1ff3b3c3 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.depot_content.rst.txt @@ -0,0 +1,34 @@ +com.vmware.esx.settings.depot\_content package +============================================== + +.. automodule:: com.vmware.esx.settings.depot_content + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.depot\_content.add\_ons\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depot_content.add_ons_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.depot\_content.base\_images\_client module +------------------------------------------------------------------ + +.. automodule:: com.vmware.esx.settings.depot_content.base_images_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.depot\_content.components\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depot_content.components_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.depots.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.depots.rst.txt new file mode 100644 index 00000000..d268a7b0 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.depots.rst.txt @@ -0,0 +1,34 @@ +com.vmware.esx.settings.depots package +====================================== + +.. automodule:: com.vmware.esx.settings.depots + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.depots.offline\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depots.offline_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.depots.online\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depots.online_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.depots.umds\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depots.umds_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hardware_support.managers.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hardware_support.managers.rst.txt new file mode 100644 index 00000000..90159ca9 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hardware_support.managers.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.hardware\_support.managers package +========================================================== + +.. automodule:: com.vmware.esx.settings.hardware_support.managers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.hardware\_support.managers.packages\_client module +-------------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hardware_support.managers.packages_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hardware_support.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hardware_support.rst.txt new file mode 100644 index 00000000..e99326aa --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hardware_support.rst.txt @@ -0,0 +1,26 @@ +com.vmware.esx.settings.hardware\_support package +================================================= + +.. automodule:: com.vmware.esx.settings.hardware_support + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.hardware_support.managers + +Submodules +---------- + +com.vmware.esx.settings.hardware\_support.managers\_client module +----------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hardware_support.managers_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.policies.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.policies.rst.txt new file mode 100644 index 00000000..8567f96e --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.policies.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.hosts.policies package +============================================== + +.. automodule:: com.vmware.esx.settings.hosts.policies + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.hosts.policies.apply\_client module +----------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts.policies.apply_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.rst.txt new file mode 100644 index 00000000..65889931 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.rst.txt @@ -0,0 +1,43 @@ +com.vmware.esx.settings.hosts package +===================================== + +.. automodule:: com.vmware.esx.settings.hosts + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.hosts.policies + com.vmware.esx.settings.hosts.software + +Submodules +---------- + +com.vmware.esx.settings.hosts.enablement\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts.enablement_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.hosts.policies\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts.policies_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.hosts.software\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts.software_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.software.drafts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.software.drafts.rst.txt new file mode 100644 index 00000000..593abd7a --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.software.drafts.rst.txt @@ -0,0 +1,18 @@ +com.vmware.esx.settings.hosts.software.drafts package +===================================================== + +.. automodule:: com.vmware.esx.settings.hosts.software.drafts + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.esx.settings.hosts.software.drafts.software\_client module +--------------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts.software.drafts.software_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.software.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.software.rst.txt new file mode 100644 index 00000000..c7857294 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.hosts.software.rst.txt @@ -0,0 +1,34 @@ +com.vmware.esx.settings.hosts.software package +============================================== + +.. automodule:: com.vmware.esx.settings.hosts.software + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.hosts.software.drafts + +Submodules +---------- + +com.vmware.esx.settings.hosts.software.drafts\_client module +------------------------------------------------------------ + +.. automodule:: com.vmware.esx.settings.hosts.software.drafts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.hosts.software.reports\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts.software.reports_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.rst.txt new file mode 100644 index 00000000..9bcee024 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.esx.settings.rst.txt @@ -0,0 +1,71 @@ +com.vmware.esx.settings package +=============================== + +.. automodule:: com.vmware.esx.settings + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.esx.settings.clusters + com.vmware.esx.settings.defaults + com.vmware.esx.settings.depot_content + com.vmware.esx.settings.depots + com.vmware.esx.settings.hardware_support + com.vmware.esx.settings.hosts + +Submodules +---------- + +com.vmware.esx.settings.clusters\_client module +----------------------------------------------- + +.. automodule:: com.vmware.esx.settings.clusters_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.defaults\_client module +----------------------------------------------- + +.. automodule:: com.vmware.esx.settings.defaults_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.depot\_content\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depot_content_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.depots\_client module +--------------------------------------------- + +.. automodule:: com.vmware.esx.settings.depots_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.hardware\_support\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hardware_support_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.esx.settings.hosts\_client module +-------------------------------------------- + +.. automodule:: com.vmware.esx.settings.hosts_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.oauth2.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.oauth2.rst.txt new file mode 100644 index 00000000..e54efe14 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.oauth2.rst.txt @@ -0,0 +1,18 @@ +com.vmware.oauth2 package +========================= + +.. automodule:: com.vmware.oauth2 + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.oauth2.errors\_client module +--------------------------------------- + +.. automodule:: com.vmware.oauth2.errors_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.rst.txt new file mode 100644 index 00000000..ba24a7ef --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.rst.txt @@ -0,0 +1,80 @@ +com.vmware package +================== + +.. automodule:: com.vmware + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.appliance + com.vmware.cis + com.vmware.content + com.vmware.esx + com.vmware.oauth2 + com.vmware.vapi + com.vmware.vcenter + +Submodules +---------- + +com.vmware.appliance\_client module +----------------------------------- + +.. automodule:: com.vmware.appliance_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.cis\_client module +----------------------------- + +.. automodule:: com.vmware.cis_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.content\_client module +--------------------------------- + +.. automodule:: com.vmware.content_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.oauth2\_client module +-------------------------------- + +.. automodule:: com.vmware.oauth2_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi\_client module +------------------------------ + +.. automodule:: com.vmware.vapi_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter\_client module +--------------------------------- + +.. automodule:: com.vmware.vcenter_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vstats\_client module +-------------------------------- + +.. automodule:: com.vmware.vstats_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.authentication.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.authentication.rst.txt new file mode 100644 index 00000000..183eb494 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.authentication.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vapi.metadata.authentication package +=============================================== + +.. automodule:: com.vmware.vapi.metadata.authentication + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vapi.metadata.authentication.service\_client module +-------------------------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.authentication.service_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.metamodel.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.metamodel.rst.txt new file mode 100644 index 00000000..cc34f009 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.metamodel.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vapi.metadata.metamodel package +========================================== + +.. automodule:: com.vmware.vapi.metadata.metamodel + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vapi.metadata.metamodel.resource\_client module +---------------------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.metamodel.resource_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi.metadata.metamodel.service\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.metamodel.service_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.privilege.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.privilege.rst.txt new file mode 100644 index 00000000..8d442b9d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.privilege.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vapi.metadata.privilege package +========================================== + +.. automodule:: com.vmware.vapi.metadata.privilege + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vapi.metadata.privilege.service\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.privilege.service_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.rst.txt new file mode 100644 index 00000000..733b1d29 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vapi.metadata.rst.txt @@ -0,0 +1,52 @@ +com.vmware.vapi.metadata package +================================ + +.. automodule:: com.vmware.vapi.metadata + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vapi.metadata.authentication + com.vmware.vapi.metadata.metamodel + com.vmware.vapi.metadata.privilege + +Submodules +---------- + +com.vmware.vapi.metadata.authentication\_client module +------------------------------------------------------ + +.. automodule:: com.vmware.vapi.metadata.authentication_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi.metadata.cli\_client module +------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.cli_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi.metadata.metamodel\_client module +------------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.metamodel_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi.metadata.privilege\_client module +------------------------------------------------- + +.. automodule:: com.vmware.vapi.metadata.privilege_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vapi.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vapi.rst.txt new file mode 100644 index 00000000..c4e2c35e --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vapi.rst.txt @@ -0,0 +1,35 @@ +com.vmware.vapi package +======================= + +.. automodule:: com.vmware.vapi + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vapi.metadata + com.vmware.vapi.std + +Submodules +---------- + +com.vmware.vapi.metadata\_client module +--------------------------------------- + +.. automodule:: com.vmware.vapi.metadata_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi.std\_client module +---------------------------------- + +.. automodule:: com.vmware.vapi.std_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vapi.std.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vapi.std.rst.txt new file mode 100644 index 00000000..707e7ed5 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vapi.std.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vapi.std package +=========================== + +.. automodule:: com.vmware.vapi.std + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vapi.std.errors\_client module +----------------------------------------- + +.. automodule:: com.vmware.vapi.std.errors_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vapi.std.routing\_client module +------------------------------------------ + +.. automodule:: com.vmware.vapi.std.routing_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.authorization.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.authorization.rst.txt new file mode 100644 index 00000000..39d7bfcd --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.authorization.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.authorization package +======================================== + +.. automodule:: com.vmware.vcenter.authorization + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.authorization.privilege\_checks\_client module +----------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.authorization.privilege_checks_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.certificate_management.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.certificate_management.rst.txt new file mode 100644 index 00000000..8c60af86 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.certificate_management.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.certificate\_management package +================================================== + +.. automodule:: com.vmware.vcenter.certificate_management + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.certificate\_management.vcenter\_client module +----------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.certificate_management.vcenter_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.rst.txt new file mode 100644 index 00000000..4de3ad94 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.rst.txt @@ -0,0 +1,66 @@ +com.vmware.vcenter.compute.policies.capabilities package +======================================================== + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.compute.policies.capabilities.vm + +Submodules +---------- + +com.vmware.vcenter.compute.policies.capabilities.cluster\_scale\_in\_ignore\_vm\_capabilities\_client module +------------------------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute.policies.capabilities.disable\_drs\_vmotion\_client module +------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute.policies.capabilities.vm\_host\_affinity\_client module +---------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute.policies.capabilities.vm\_host\_anti\_affinity\_client module +---------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute.policies.capabilities.vm\_vm\_affinity\_client module +-------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute.policies.capabilities.vm\_vm\_anti\_affinity\_client module +-------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.rst.txt new file mode 100644 index 00000000..e29a6ac6 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package +====================================================================== + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm.evacuation + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion\_client module +------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.placement.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.placement.rst.txt new file mode 100644 index 00000000..d913c429 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.placement.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.compute.policies.capabilities.vm.placement package +===================================================================== + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm.placement + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti\_affinity\_with\_vcls\_client module +------------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.rst.txt new file mode 100644 index 00000000..98210641 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.capabilities.vm.rst.txt @@ -0,0 +1,35 @@ +com.vmware.vcenter.compute.policies.capabilities.vm package +=========================================================== + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.compute.policies.capabilities.vm.evacuation + com.vmware.vcenter.compute.policies.capabilities.vm.placement + +Submodules +---------- + +com.vmware.vcenter.compute.policies.capabilities.vm.evacuation\_client module +----------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm.evacuation_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute.policies.capabilities.vm.placement\_client module +---------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities.vm.placement_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.rst.txt new file mode 100644 index 00000000..f903ea6d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.policies.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.compute.policies package +=========================================== + +.. automodule:: com.vmware.vcenter.compute.policies + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.compute.policies.capabilities + +Submodules +---------- + +com.vmware.vcenter.compute.policies.capabilities\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies.capabilities_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.rst.txt new file mode 100644 index 00000000..fbd0af3d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.compute.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.compute package +================================== + +.. automodule:: com.vmware.vcenter.compute + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.compute.policies + +Submodules +---------- + +com.vmware.vcenter.compute.policies\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.vcenter.compute.policies_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.confidential_computing.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.confidential_computing.rst.txt new file mode 100644 index 00000000..622d7f6e --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.confidential_computing.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.confidential\_computing package +================================================== + +.. automodule:: com.vmware.vcenter.confidential_computing + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.confidential\_computing.sgx\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.confidential_computing.sgx_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.consumption_domains.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.consumption_domains.rst.txt new file mode 100644 index 00000000..dead23ae --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.consumption_domains.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.consumption\_domains package +=============================================== + +.. automodule:: com.vmware.vcenter.consumption_domains + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.consumption_domains.zones + +Submodules +---------- + +com.vmware.vcenter.consumption\_domains.zone\_associations\_client module +------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.consumption_domains.zone_associations_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.consumption_domains.zones.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.consumption_domains.zones.rst.txt new file mode 100644 index 00000000..ccfa6340 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.consumption_domains.zones.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.consumption\_domains.zones package +===================================================== + +.. automodule:: com.vmware.vcenter.consumption_domains.zones + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.consumption\_domains.zones.cluster\_client module +-------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.consumption_domains.zones.cluster_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.content.registries.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.content.registries.rst.txt new file mode 100644 index 00000000..6c0aa18a --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.content.registries.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.content.registries package +============================================= + +.. automodule:: com.vmware.vcenter.content.registries + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.content.registries.harbor\_client module +----------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.content.registries.harbor_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.content.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.content.rst.txt new file mode 100644 index 00000000..3a69725f --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.content.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.content package +================================== + +.. automodule:: com.vmware.vcenter.content + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.content.registries + +Submodules +---------- + +com.vmware.vcenter.content.registries\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.vcenter.content.registries_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.crypto_manager.hosts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.crypto_manager.hosts.rst.txt new file mode 100644 index 00000000..41dc54d8 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.crypto_manager.hosts.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.crypto\_manager.hosts package +================================================ + +.. automodule:: com.vmware.vcenter.crypto_manager.hosts + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.crypto\_manager.hosts.kms\_client module +----------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.crypto_manager.hosts.kms_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.crypto_manager.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.crypto_manager.rst.txt new file mode 100644 index 00000000..b8e50281 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.crypto_manager.rst.txt @@ -0,0 +1,34 @@ +com.vmware.vcenter.crypto\_manager package +========================================== + +.. automodule:: com.vmware.vcenter.crypto_manager + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.crypto_manager.hosts + +Submodules +---------- + +com.vmware.vcenter.crypto\_manager.hosts\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.crypto_manager.hosts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.crypto\_manager.kms\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.vcenter.crypto_manager.kms_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.install.initial_config.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.install.initial_config.rst.txt new file mode 100644 index 00000000..8081b787 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.install.initial_config.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.deployment.install.initial\_config package +============================================================= + +.. automodule:: com.vmware.vcenter.deployment.install.initial_config + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.deployment.install.initial\_config.remote\_psc\_client module +-------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.deployment.install.initial_config.remote_psc_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.install.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.install.rst.txt new file mode 100644 index 00000000..1476ef85 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.install.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.deployment.install package +============================================= + +.. automodule:: com.vmware.vcenter.deployment.install + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.deployment.install.initial_config + +Submodules +---------- + +com.vmware.vcenter.deployment.install.psc\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.deployment.install.psc_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.rst.txt new file mode 100644 index 00000000..0eb69ef1 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.deployment.rst.txt @@ -0,0 +1,34 @@ +com.vmware.vcenter.deployment package +===================================== + +.. automodule:: com.vmware.vcenter.deployment + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.deployment.install + +Submodules +---------- + +com.vmware.vcenter.deployment.install\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.vcenter.deployment.install_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.deployment.migrate\_client module +---------------------------------------------------- + +.. automodule:: com.vmware.vcenter.deployment.migrate_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.host.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.host.rst.txt new file mode 100644 index 00000000..d5afd9c6 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.host.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.host package +=============================== + +.. automodule:: com.vmware.vcenter.host + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.host.entropy\_client module +---------------------------------------------- + +.. automodule:: com.vmware.vcenter.host.entropy_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.hvc.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.hvc.rst.txt new file mode 100644 index 00000000..0faa1b5d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.hvc.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.hvc package +============================== + +.. automodule:: com.vmware.vcenter.hvc + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.hvc.management\_client module +------------------------------------------------ + +.. automodule:: com.vmware.vcenter.hvc.management_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.identity.broker.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.identity.broker.rst.txt new file mode 100644 index 00000000..4731a022 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.identity.broker.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.identity.broker package +========================================== + +.. automodule:: com.vmware.vcenter.identity.broker + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.identity.broker.tenants\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.identity.broker.tenants_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.identity.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.identity.rst.txt new file mode 100644 index 00000000..e11b5990 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.identity.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.identity package +=================================== + +.. automodule:: com.vmware.vcenter.identity + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.identity.broker + +Submodules +---------- + +com.vmware.vcenter.identity.broker\_client module +------------------------------------------------- + +.. automodule:: com.vmware.vcenter.identity.broker_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.lcm.deployment.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.lcm.deployment.rst.txt new file mode 100644 index 00000000..ffd416bc --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.lcm.deployment.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.lcm.deployment package +========================================= + +.. automodule:: com.vmware.vcenter.lcm.deployment + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.lcm.deployment.common\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.lcm.deployment.common_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.lcm.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.lcm.rst.txt new file mode 100644 index 00000000..82e8a613 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.lcm.rst.txt @@ -0,0 +1,42 @@ +com.vmware.vcenter.lcm package +============================== + +.. automodule:: com.vmware.vcenter.lcm + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.lcm.deployment + +Submodules +---------- + +com.vmware.vcenter.lcm.deployment\_client module +------------------------------------------------ + +.. automodule:: com.vmware.vcenter.lcm.deployment_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.lcm.discovery\_client module +----------------------------------------------- + +.. automodule:: com.vmware.vcenter.lcm.discovery_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.lcm.update\_client module +-------------------------------------------- + +.. automodule:: com.vmware.vcenter.lcm.update_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.networks.nsx.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.networks.nsx.rst.txt new file mode 100644 index 00000000..f6c85fc7 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.networks.nsx.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.namespace\_management.networks.nsx package +============================================================= + +.. automodule:: com.vmware.vcenter.namespace_management.networks.nsx + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.namespace\_management.networks.nsx.distributed\_switches\_client module +------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.networks.nsx.edges\_client module +-------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.networks.nsx.edges_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.networks.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.networks.rst.txt new file mode 100644 index 00000000..2ee04c9d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.networks.rst.txt @@ -0,0 +1,42 @@ +com.vmware.vcenter.namespace\_management.networks package +========================================================= + +.. automodule:: com.vmware.vcenter.namespace_management.networks + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.namespace_management.networks.nsx + +Submodules +---------- + +com.vmware.vcenter.namespace\_management.networks.edges\_client module +---------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.networks.edges_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.networks.nsx\_client module +-------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.networks.nsx_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.networks.service\_client module +------------------------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.namespace_management.networks.service_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.rst.txt new file mode 100644 index 00000000..629eb27e --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.rst.txt @@ -0,0 +1,83 @@ +com.vmware.vcenter.namespace\_management package +================================================ + +.. automodule:: com.vmware.vcenter.namespace_management + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.namespace_management.networks + com.vmware.vcenter.namespace_management.supervisors + +Submodules +---------- + +com.vmware.vcenter.namespace\_management.clusters\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.clusters_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.cns\_client module +----------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.cns_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.networks\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.networks_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.software\_client module +---------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.software_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.stats\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.stats_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.storage\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.storage_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.supervisor\_services\_client module +---------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.supervisor_services_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.supervisors\_client module +------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.supervisors_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.supervisors.networks.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.supervisors.networks.rst.txt new file mode 100644 index 00000000..c046a175 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.supervisors.networks.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.namespace\_management.supervisors.networks package +===================================================================== + +.. automodule:: com.vmware.vcenter.namespace_management.supervisors.networks + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.namespace\_management.supervisors.networks.management\_client module +--------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.supervisors.networks.management_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management.supervisors.networks.workload\_client module +------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.supervisors.networks.workload_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.supervisors.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.supervisors.rst.txt new file mode 100644 index 00000000..39517e3c --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespace_management.supervisors.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.namespace\_management.supervisors package +============================================================ + +.. automodule:: com.vmware.vcenter.namespace_management.supervisors + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.namespace_management.supervisors.networks + +Submodules +---------- + +com.vmware.vcenter.namespace\_management.supervisors.identity\_client module +---------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management.supervisors.identity_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespaces.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespaces.rst.txt new file mode 100644 index 00000000..60a88d09 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.namespaces.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.namespaces package +===================================== + +.. automodule:: com.vmware.vcenter.namespaces + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.namespaces.user\_client module +------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespaces.user_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.rst.txt new file mode 100644 index 00000000..5c6627f4 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.rst.txt @@ -0,0 +1,261 @@ +com.vmware.vcenter package +========================== + +.. automodule:: com.vmware.vcenter + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.authorization + com.vmware.vcenter.certificate_management + com.vmware.vcenter.compute + com.vmware.vcenter.confidential_computing + com.vmware.vcenter.consumption_domains + com.vmware.vcenter.content + com.vmware.vcenter.crypto_manager + com.vmware.vcenter.deployment + com.vmware.vcenter.host + com.vmware.vcenter.hvc + com.vmware.vcenter.identity + com.vmware.vcenter.lcm + com.vmware.vcenter.namespace_management + com.vmware.vcenter.namespaces + com.vmware.vcenter.storage + com.vmware.vcenter.system_config + com.vmware.vcenter.trusted_infrastructure + com.vmware.vcenter.vcha + com.vmware.vcenter.vm + com.vmware.vcenter.vm_template + +Submodules +---------- + +com.vmware.vcenter.authentication\_client module +------------------------------------------------ + +.. automodule:: com.vmware.vcenter.authentication_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.authorization\_client module +----------------------------------------------- + +.. automodule:: com.vmware.vcenter.authorization_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.certificate\_management\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.certificate_management_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.compute\_client module +----------------------------------------- + +.. automodule:: com.vmware.vcenter.compute_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.consumption\_domains\_client module +------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.consumption_domains_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.crypto\_manager\_client module +------------------------------------------------- + +.. automodule:: com.vmware.vcenter.crypto_manager_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.datastore\_client module +------------------------------------------- + +.. automodule:: com.vmware.vcenter.datastore_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.deployment\_client module +-------------------------------------------- + +.. automodule:: com.vmware.vcenter.deployment_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.guest\_client module +--------------------------------------- + +.. automodule:: com.vmware.vcenter.guest_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.host\_client module +-------------------------------------- + +.. automodule:: com.vmware.vcenter.host_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.hvc\_client module +------------------------------------- + +.. automodule:: com.vmware.vcenter.hvc_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.identity\_client module +------------------------------------------ + +.. automodule:: com.vmware.vcenter.identity_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.inventory\_client module +------------------------------------------- + +.. automodule:: com.vmware.vcenter.inventory_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.iso\_client module +------------------------------------- + +.. automodule:: com.vmware.vcenter.iso_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.lcm\_client module +------------------------------------- + +.. automodule:: com.vmware.vcenter.lcm_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespace\_management\_client module +------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespace_management_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.namespaces\_client module +-------------------------------------------- + +.. automodule:: com.vmware.vcenter.namespaces_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.ovf\_client module +------------------------------------- + +.. automodule:: com.vmware.vcenter.ovf_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.services\_client module +------------------------------------------ + +.. automodule:: com.vmware.vcenter.services_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.storage\_client module +----------------------------------------- + +.. automodule:: com.vmware.vcenter.storage_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.system\_config\_client module +------------------------------------------------ + +.. automodule:: com.vmware.vcenter.system_config_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.tagging\_client module +----------------------------------------- + +.. automodule:: com.vmware.vcenter.tagging_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.tokenservice\_client module +---------------------------------------------- + +.. automodule:: com.vmware.vcenter.tokenservice_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.topology\_client module +------------------------------------------ + +.. automodule:: com.vmware.vcenter.topology_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure\_client module +--------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vcha\_client module +-------------------------------------- + +.. automodule:: com.vmware.vcenter.vcha_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm\_client module +------------------------------------ + +.. automodule:: com.vmware.vcenter.vm_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm\_template\_client module +---------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm_template_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.storage.policies.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.storage.policies.rst.txt new file mode 100644 index 00000000..b8c4aef5 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.storage.policies.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.storage.policies package +=========================================== + +.. automodule:: com.vmware.vcenter.storage.policies + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.storage.policies.compliance\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.storage.policies.compliance_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.storage.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.storage.rst.txt new file mode 100644 index 00000000..7447d3c0 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.storage.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.storage package +================================== + +.. automodule:: com.vmware.vcenter.storage + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.storage.policies + +Submodules +---------- + +com.vmware.vcenter.storage.policies\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.vcenter.storage.policies_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.system_config.features.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.system_config.features.rst.txt new file mode 100644 index 00000000..94679256 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.system_config.features.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.system\_config.features package +================================================== + +.. automodule:: com.vmware.vcenter.system_config.features + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.system\_config.features.tech\_preview\_client module +----------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.system_config.features.tech_preview_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.system_config.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.system_config.rst.txt new file mode 100644 index 00000000..3c3a1643 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.system_config.rst.txt @@ -0,0 +1,15 @@ +com.vmware.vcenter.system\_config package +========================================= + +.. automodule:: com.vmware.vcenter.system_config + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.system_config.features diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.rst.txt new file mode 100644 index 00000000..0baf867d --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.trusted\_infrastructure.hosts.hardware package +================================================================= + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.hosts.hardware + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.hosts.hardware.tpm\_client module +---------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.hosts.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.hosts.rst.txt new file mode 100644 index 00000000..2ab874c4 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.hosts.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.trusted\_infrastructure.hosts package +======================================================== + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.hosts + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.trusted_infrastructure.hosts.hardware + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.hosts.hardware\_client module +------------------------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.rst.txt new file mode 100644 index 00000000..199267b4 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.rst.txt @@ -0,0 +1,68 @@ +com.vmware.vcenter.trusted\_infrastructure package +================================================== + +.. automodule:: com.vmware.vcenter.trusted_infrastructure + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.trusted_infrastructure.hosts + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters + com.vmware.vcenter.trusted_infrastructure.trusted_clusters + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.attestation\_client module +--------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.attestation_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.hosts\_client module +--------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.hosts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.kms\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.kms_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters\_client module +------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_hosts\_client module +--------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.trusted\_clusters\_client module +--------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.rst.txt new file mode 100644 index 00000000..c051d81a --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.attestation.os package +============================================================================================ + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.attestation.os.esx\_client module +------------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.rst.txt new file mode 100644 index 00000000..ba8350aa --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.attestation package +========================================================================================= + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.attestation.tpm2\_client module +----------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.rst.txt new file mode 100644 index 00000000..61d47ab9 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.kms.providers package +=========================================================================================== + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.kms.providers.client\_certificate\_client module +---------------------------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.rst.txt new file mode 100644 index 00000000..f3812a37 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.kms package +================================================================================= + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.kms.providers\_client module +-------------------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.rst.txt new file mode 100644 index 00000000..08136fb3 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.rst.txt @@ -0,0 +1,35 @@ +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters package +============================================================================= + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.attestation\_client module +------------------------------------------------------------------------------------------------ + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.trust\_authority\_clusters.kms\_client module +---------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.rst.txt new file mode 100644 index 00000000..870a9967 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.trusted\_infrastructure.trusted\_clusters package +==================================================================== + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trusted_clusters + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.trusted\_infrastructure.trusted\_clusters.attestation\_client module +--------------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.trusted\_infrastructure.trusted\_clusters.kms\_client module +------------------------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vcha.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vcha.rst.txt new file mode 100644 index 00000000..32f9ce52 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vcha.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.vcha package +=============================== + +.. automodule:: com.vmware.vcenter.vcha + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.vcha.cluster\_client module +---------------------------------------------- + +.. automodule:: com.vmware.vcenter.vcha.cluster_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.guest.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.guest.rst.txt new file mode 100644 index 00000000..b5422660 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.guest.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.vm.guest package +=================================== + +.. automodule:: com.vmware.vcenter.vm.guest + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.vm.guest.filesystem\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.guest.filesystem_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.guest.networking\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.guest.networking_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.hardware.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.hardware.rst.txt new file mode 100644 index 00000000..c4e82f91 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.hardware.rst.txt @@ -0,0 +1,26 @@ +com.vmware.vcenter.vm.hardware package +====================================== + +.. automodule:: com.vmware.vcenter.vm.hardware + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.vm.hardware.adapter\_client module +----------------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.hardware.adapter_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.hardware.boot\_client module +-------------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.hardware.boot_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.rst.txt new file mode 100644 index 00000000..01d2c701 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.rst.txt @@ -0,0 +1,76 @@ +com.vmware.vcenter.vm package +============================= + +.. automodule:: com.vmware.vcenter.vm + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 10 + + com.vmware.vcenter.vm.guest + com.vmware.vcenter.vm.hardware + com.vmware.vcenter.vm.storage + +Submodules +---------- + +com.vmware.vcenter.vm.compute\_client module +-------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.compute_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.console\_client module +-------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.console_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.data\_sets\_client module +----------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.data_sets_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.guest\_client module +------------------------------------------ + +.. automodule:: com.vmware.vcenter.vm.guest_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.hardware\_client module +--------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.hardware_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.storage\_client module +-------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.storage_client + :members: + :undoc-members: + :show-inheritance: + +com.vmware.vcenter.vm.tools\_client module +------------------------------------------ + +.. automodule:: com.vmware.vcenter.vm.tools_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.storage.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.storage.rst.txt new file mode 100644 index 00000000..8e9f7bac --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm.storage.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.vm.storage package +===================================== + +.. automodule:: com.vmware.vcenter.vm.storage + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.vm.storage.policy\_client module +--------------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm.storage.policy_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm_template.rst.txt b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm_template.rst.txt new file mode 100644 index 00000000..eb879b04 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/com.vmware.vcenter.vm_template.rst.txt @@ -0,0 +1,18 @@ +com.vmware.vcenter.vm\_template package +======================================= + +.. automodule:: com.vmware.vcenter.vm_template + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +com.vmware.vcenter.vm\_template.library\_items\_client module +------------------------------------------------------------- + +.. automodule:: com.vmware.vcenter.vm_template.library_items_client + :members: + :undoc-members: + :show-inheritance: diff --git a/vsphere/8.0.2.0/_sources/enumeration.rst.txt b/vsphere/8.0.2.0/_sources/enumeration.rst.txt new file mode 100644 index 00000000..afe09e47 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/enumeration.rst.txt @@ -0,0 +1,82 @@ +.. _enumeration_description: + +Interface definition language to python mapping for enumerated types +-------------------------------------------------------------------- + +The interface language definition type system includes enumerated types. Python +SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does +not have first class support for enumerations, special classes are +generated to represent enumerated types from the interface definition +language. The special class contains class attributes which represent +the values of the enumerated type. + +This documentation explains the following: + +* How the class variables are defined in the module. This specifies the names that you can use in your program. +* How you instantiate a class to use it for communication with future versions of the service. + +Example of an enumerated type documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +*class* com.vmware.vapi.metadata_client. **SourceType** (string) + Bases: vmware.vapi.bindings.enum.Enum + + Metadata source type + + .. note:: + This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See :ref:`enumerated type description page `. + + **Parameters** : **string** (``str``) – String value for the SourceType instance. + + **FILE** = *SourceType(string='FILE')* + If the source is backed by a file. + + **REMOTE** = *SourceType(string='REMOTE')* + If the source is backed by a remote service. + +Code Examples +^^^^^^^^^^^^^ + +The enumerated type classes are defined in python modules that your code +imports. You can use these in your code. + +1. If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class. + +.. code-block:: python + + # SourceType is an enumerated type + from com.vmware.vapi.metadata_client import SourceType + + # SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE + spec = Source.CreateSpec(type=SourceType.FILE, filepath='entity_metadata.json', description='Entity service') + source_svc.create(id='entity', spec=spec) + +2. When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values. + +.. code-block:: python + + # SourceType is an enumerated type + from com.vmware.vapi.metadata_client import SourceType + + source_info = source_svc.get(id='entity') + if (source_info.type == SourceType.FILE) { + print 'Source is a file' + } else if (source_info.type == SourceType.REMOTE) { + print 'Source is a remote provider' + } else { + print 'Unknown source type: %s' % str(source_info.type) + } + +3. Sending a new enumerated type value to a server that has a newer version of the enumerated type. + +To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the +enumerated type class. + +.. code-block:: python + + # If a newer version of SourceType has a new value FOLDER, FOLDER would be one + # of the class attributes for SourceType. In the older version, SourceType has + # only two class attributes, FILE and REMOTE + from com.vmware.vapi.metadata_client import SourceType + spec = Source.CreateSpec(type=SourceType('FOLDER'), filepath='entity_metadata', description='Entity service') + source_svc.create(id='entity', spec=spec) diff --git a/vsphere/8.0.2.0/_sources/index.rst.txt b/vsphere/8.0.2.0/_sources/index.rst.txt new file mode 100644 index 00000000..b56a9790 --- /dev/null +++ b/vsphere/8.0.2.0/_sources/index.rst.txt @@ -0,0 +1,21 @@ +.. vSphere Automation SDK for Python. documentation master file, created by + sphinx-quickstart on Tue Sep 5 18:45:54 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to vSphere Automation SDK for Python.'s documentation! +============================================================== + +.. toctree:: + :maxdepth: 10 + :caption: Contents: + + com + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/vsphere/8.0.2.0/_static/basic.css b/vsphere/8.0.2.0/_static/basic.css new file mode 100644 index 00000000..912859b5 --- /dev/null +++ b/vsphere/8.0.2.0/_static/basic.css @@ -0,0 +1,904 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/vsphere/8.0.2.0/_static/css/badge_only.css b/vsphere/8.0.2.0/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/vsphere/8.0.2.0/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Bold.woff b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Regular.woff b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.eot b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.svg b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.ttf b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.woff b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.woff2 b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-bold-italic.woff b/vsphere/8.0.2.0/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-bold-italic.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-bold-italic.woff2 b/vsphere/8.0.2.0/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-bold.woff b/vsphere/8.0.2.0/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-bold.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-bold.woff2 b/vsphere/8.0.2.0/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-bold.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-normal-italic.woff b/vsphere/8.0.2.0/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-normal-italic.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-normal-italic.woff2 b/vsphere/8.0.2.0/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-normal.woff b/vsphere/8.0.2.0/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-normal.woff differ diff --git a/vsphere/8.0.2.0/_static/css/fonts/lato-normal.woff2 b/vsphere/8.0.2.0/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/vsphere/8.0.2.0/_static/css/fonts/lato-normal.woff2 differ diff --git a/vsphere/8.0.2.0/_static/css/theme.css b/vsphere/8.0.2.0/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/vsphere/8.0.2.0/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/vsphere/8.0.2.0/_static/doctools.js b/vsphere/8.0.2.0/_static/doctools.js new file mode 100644 index 00000000..8cbf1b16 --- /dev/null +++ b/vsphere/8.0.2.0/_static/doctools.js @@ -0,0 +1,323 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + break; + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + break; + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/vsphere/8.0.2.0/_static/documentation_options.js b/vsphere/8.0.2.0/_static/documentation_options.js new file mode 100644 index 00000000..e0abb039 --- /dev/null +++ b/vsphere/8.0.2.0/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '8.0.2.0', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/vsphere/8.0.2.0/_static/file.png b/vsphere/8.0.2.0/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/vsphere/8.0.2.0/_static/file.png differ diff --git a/vsphere/8.0.2.0/_static/jquery-3.5.1.js b/vsphere/8.0.2.0/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/vsphere/8.0.2.0/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com package

+
+

Subpackages

+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.html b/vsphere/8.0.2.0/com.vmware.appliance.html new file mode 100644 index 00000000..08b52ac6 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.html @@ -0,0 +1,4896 @@ + + + + + + + com.vmware.appliance package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.access_client module

+

The com.vmware.appliance.access_client module provides classes for managing +access to the appliance. The module is available starting in vSphere 6.5.

+
+
+class com.vmware.appliance.access_client.Consolecli(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Consolecli class provides methods Get/Set enabled state of CLI.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get enabled state of the console-based controlled CLI (TTY1).

+
+
Return type
+

bool

+
+
Returns
+

Console-based controlled CLI is enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(enabled)
+

Set enabled state of the console-based controlled CLI (TTY1).

+
+
Parameters
+

enabled (bool) – Console-based controlled CLI is enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.access_client.Dcui(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Dcui class provides methods Get/Set enabled state of DCUI.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get enabled state of Direct Console User Interface (DCUI TTY2).

+
+
Return type
+

bool

+
+
Returns
+

DCUI is enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(enabled)
+

Set enabled state of Direct Console User Interface (DCUI TTY2).

+
+
Parameters
+

enabled (bool) – DCUI is enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.access_client.Shell(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Shell class provides methods Get/Set enabled state of BASH.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ShellConfig(enabled=None, timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Shell.ShellConfig class Structure that defines shell configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Enabled can be set to true or false

    • +

  • timeout (long) – The timeout (in seconds) specifies how long you enable the Shell +access. The maximum timeout is 86400 seconds(1 day).

    • +
+
+
+
+ +
+
+get()
+

Get enabled state of BASH, that is, access to BASH from within the +controlled CLI.

+
+
Return type
+

Shell.ShellConfig

+
+
Returns
+

Current shell configuration.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(config)
+

Set enabled state of BASH, that is, access to BASH from within the +controlled CLI.

+
+
Parameters
+

config (Shell.ShellConfig) – Shell configuration

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.access_client.Ssh(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Ssh class provides methods Get/Set enabled state of SSH-based +controlled CLI.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get enabled state of the SSH-based controlled CLI.

+
+
Return type
+

bool

+
+
Returns
+

SSH-based controlled CLI is enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(enabled)
+

Set enabled state of the SSH-based controlled CLI.

+
+
Parameters
+

enabled (bool) – SSH-based controlled CLI is enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.access_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.health_client module

+

The com.vmware.appliance.health_client module provides classes for +reporting the health of the various subsystems of the the appliance. The module +is available starting in vSphere 6.5.

+
+
+class com.vmware.appliance.health_client.Applmgmt(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Applmgmt class provides methods Get health status of applmgmt services.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get health status of applmgmt services.

+
+
Return type
+

str

+
+
Returns
+

health status

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.Database(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Database class provides methods to retrieve the health status of +the vcdb. This class was added in vSphere API 7.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Database.Info class contains information about the health of the +the database. This class was added in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Database.Info.Status) – Database health status. This attribute was added in vSphere API +7.0.0.1.

    • +

  • messages (list of Database.Message) – Messages describing any issues with the database, along with their +severity. This attribute was added in vSphere API 7.0.0.1.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Database.Info.Status class describes the health of the database. +This enumeration was added in vSphere API 7.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+DEGRADED = Status(string='DEGRADED')
+

The database has issues but the impact on vCenter Server is low. This class +attribute was added in vSphere API 7.0.0.1.

+
+ +
+
+HEALTHY = Status(string='HEALTHY')
+

The database is healthy. This class attribute was added in vSphere API +7.0.0.1.

+
+ +
+
+UNHEALTHY = Status(string='UNHEALTHY')
+

The database is corrupted and vCenter server functionality will be +impacted. This class attribute was added in vSphere API 7.0.0.1.

+
+ +
+ +
+ +
+
+class Message(severity=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Database.Message class contains a database health message along +with its severity. This class was added in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Severity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The MessageSeverity class defines the levels of severity for a message. +This enumeration was added in vSphere API 7.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Severity instance.

+
+
+
+
+ERROR = Severity(string='ERROR')
+

Error message. This class attribute was added in vSphere API 7.0.0.1.

+
+ +
+
+WARNING = Severity(string='WARNING')
+

Warning message. This class attribute was added in vSphere API 7.0.0.1.

+
+ +
+ +
+ +
+
+get()
+

Returns the health status of the database. This method was added in +vSphere API 7.0.0.1.

+
+
Return type
+

Database.Info

+
+
Returns
+

Health status of the database

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if issue in retrieving health of the database

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.Databasestorage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Databasestorage class provides methods Get database storage health.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Databasestorage.HealthLevel class Defines service health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

The service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems.

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy but experiencing some problems.

+
+ +
+ +
+
+get()
+

Get database storage health.

+
+
Return type
+

Databasestorage.HealthLevel

+
+
Returns
+

Database storage health

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.Load(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Load class provides methods Get load health.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Load.HealthLevel class Defines health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

Service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems.

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy state, but experiencing some levels of problems.

+
+ +
+ +
+
+get()
+

Get load health.

+
+
Return type
+

Load.HealthLevel

+
+
Returns
+

Load health.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.Mem(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Mem class provides methods Get memory health.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Mem.HealthLevel class Defines health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

Service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy state, but experiencing some levels of problems.

+
+ +
+ +
+
+get()
+

Get memory health.

+
+
Return type
+

Mem.HealthLevel

+
+
Returns
+

Memory health.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.Softwarepackages(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Softwarepackages class provides methods Get information on available +software updates available in remote VUM repository.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Softwarepackages.HealthLevel class Defines health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

Service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems.

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy state, but experiencing some levels of problems.

+
+ +
+ +
+
+get()
+

Get information on available software updates available in the remote +vSphere Update Manager repository. Red indicates that security updates +are available. Orange indicates that non-security updates are +available. Green indicates that there are no updates available. Gray +indicates that there was an error retreiving information on software +updates.

+
+
Return type
+

Softwarepackages.HealthLevel

+
+
Returns
+

software updates available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.Storage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Storage class provides methods Get storage health.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Storage.HealthLevel class Defines health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

Service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems.

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy state, but experiencing some levels of problems.

+
+ +
+ +
+
+get()
+

Get storage health.

+
+
Return type
+

Storage.HealthLevel

+
+
Returns
+

Storage health.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.health_client.Swap(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Swap class provides methods Get swap health.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Swap.HealthLevel class Defines health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

Service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems.

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy state, but experiencing some levels of problems.

+
+ +
+ +
+
+get()
+

Get swap health.

+
+
Return type
+

Swap.HealthLevel

+
+
Returns
+

Swap health

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.health_client.System(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

System class provides methods Get overall health of the system.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HealthLevel(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

System.HealthLevel class Defines health levels.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthLevel instance.

+
+
+
+
+gray = HealthLevel(string='gray')
+

No health data is available for this service.

+
+ +
+
+green = HealthLevel(string='green')
+

Service is healthy.

+
+ +
+
+orange = HealthLevel(string='orange')
+

The service health is degraded. The service might have serious problems.

+
+ +
+
+red = HealthLevel(string='red')
+

The service is unavaiable, not functioning properly, or will stop +functioning soon.

+
+ +
+
+yellow = HealthLevel(string='yellow')
+

The service is healthy state, but experiencing some levels of problems.

+
+ +
+ +
+
+get()
+

Get overall health of system.

+
+
Return type
+

System.HealthLevel

+
+
Returns
+

System health

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+lastcheck()
+

Get last check timestamp of the health of the system.

+
+
Return type
+

datetime.datetime

+
+
Returns
+

System health last check timestamp

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+

com.vmware.appliance.infraprofile_client module

+

The com.vmware.appliance.infraprofile_client module provides classes to +manage profile spec for the appliance

+
+
+class com.vmware.appliance.infraprofile_client.Configs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Configs class provides methods to manage desired configuration +specification of an appliance.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ImportProfileSpec(config_spec=None, profile_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configs.ImportProfileSpec class represents a spec information for +import and validate.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config_spec (str) – The JSON string representing the desired config specification.

    • +

  • profile_spec (Configs.ProfilesSpec or None) – The profile specification, if any +only set if there is a profilespec avaliable for this +import profilespec.

    • +
+
+
+
+ +
+
+class ProfileInfo(name=None, info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configs.ProfileInfo class defines the information about profile.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the profile which is also a profile identifier. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.infraprofile.profile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.infraprofile.profile.

    • +

  • info (str) – Description of the profile.

    • +
+
+
+
+ +
+
+class ProfilesSpec(encryption_key=None, description=None, profiles=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configs.ProfilesSpec class represents a spec information for export +operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • encryption_key (str or None) – Encryption Key to encrypt/decrypt profiles. +If None encryption will not be used for the profile.

    • +

  • description (str or None) – Custom description provided by the user. +If None description will be empty.

    • +

  • profiles (set of str or None) – Profiles to be exported/imported. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.infraprofile.profile. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.infraprofile.profile. +If None or empty, all profiles will be returned.

    • +
+
+
+
+ +
+
+class ValidationResult(status=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configs.ValidationResult class contains attributes to describe +result of validation of profile specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Configs.ValidationStatus) – Status of the Profile spec.

    • +

  • notifications (Notifications or None) – Notifications to the user +Only set if the notifications were reported by this +particular validation.

    • +
+
+
+
+ +
+
+class ValidationStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Configs.ValidationStatus class defines possible values of status of +profile spec.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ValidationStatus instance.

+
+
+
+
+INVALID = ValidationStatus(string='INVALID')
+

Profile spec is invalid.

+
+ +
+
+VALID = ValidationStatus(string='VALID')
+

Profile spec is valid.

+
+ +
+ +
+
+export(spec=None)
+

Exports the desired profile specification.

+
+
Parameters
+

spec (Configs.ProfilesSpec or None) – information to export the profile.

+
+
Return type
+

str

+
+
Returns
+

Configuration specification JSON in string format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no profile associated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+import_profile_task(spec)
+

Imports the desired profile specification.

+
+
Parameters
+

spec (Configs.ImportProfileSpec) – information to import the profile.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no profile associated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+list()
+

List all the profiles which are registered.

+
+
Return type
+

list of Configs.ProfileInfo

+
+
Returns
+

List of profiles with description are registered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+validate_task(spec)
+

Validates the desired profile specification.

+
+
Parameters
+

spec (Configs.ImportProfileSpec) – information to validate the profile.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no profile associated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.infraprofile_client.Notification(notification=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class contains attributes to describe any +info/warning/error messages that Tasks can raise.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • notification (str) – The notification id. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.infraprofile.notification. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.infraprofile.notification.

    • +

  • time (datetime.datetime or None) – The time the notification was raised/found. +Only set if the time information is available.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. +Only set for warnings and errors.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.infraprofile_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the task.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. +Only set if an info was reported by the task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. +Only set if an warning was reported by the task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. +Only set if an error was reported by the task.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.infraprofile_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.infraprofile_client.TaskInfo(progress=None, notifications=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TaskInfo class contains information about a task.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – Progress of the operation. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • notifications (Notifications or None) – Notifications to the user +Only set if the notifications were reported by this +particular task.

    • +

  • result (DataValue or None) – Task result. +This attribute will be None if the task has no result.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.local_accounts_client module

+
+
+class com.vmware.appliance.local_accounts_client.Policy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Policy class provides methods to manage local user accounts. This +class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(max_days=None, min_days=None, warn_days=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.Info class defines the global password policy. This class +was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • max_days (long or None) – Maximum number of days a password may be used. If the password is +older than this, a password change will be forced. This attribute +was added in vSphere API 6.7. +If None then the restriction will be ignored.

    • +

  • min_days (long or None) – Minimum number of days allowed between password changes. Any +password changes attempted sooner than this will be rejected. This +attribute was added in vSphere API 6.7. +If None then the restriction will be ignored.

    • +

  • warn_days (long or None) – Number of days warning given before a password expires. A zero +means warning is given only upon the day of expiration. This +attribute was added in vSphere API 6.7. +If None then no warning will be provided.

    • +
+
+
+
+ +
+
+get()
+

Get the global password policy. This method was added in vSphere API +6.7.

+
+
Return type
+

Policy.Info

+
+
Returns
+

Global password policy

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(policy)
+

Set the global password policy. This method was added in vSphere API +6.7.

+
+
Parameters
+

policy (Policy.Info) – Global password policy

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed policy values are < -1 or > 99999

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.local_accounts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.localaccounts_client module

+

The com.vmware.appliancelocalaccounts module provides classes for managing +local (OS) accounts in the appliance. The module is available starting in +vSphere 6.5.

+
+
+class com.vmware.appliance.localaccounts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.logging_client module

+

The com.vmware.appliance.logging_client module provides classes for +managing log forwarding in the appliance. The module is available starting in +vSphere 6.5.

+
+
+class com.vmware.appliance.logging_client.Forwarding(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Forwarding class provides methods to manage forwarding of log +messages to remote logging servers. This class was added in vSphere API +6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Config(hostname=None, port=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Forwarding.Config class defines the configuration for log message +forwarding to remote logging servers. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – FQDN or IP address of the logging server to which messages are +forwarded. This attribute was added in vSphere API 6.7.

    • +

  • port (long) – The port on which the remote logging server is listening for +forwarded log messages. This attribute was added in vSphere API +6.7.

    • +

  • protocol (Forwarding.Protocol) – Transport protocol used to forward log messages. This attribute was +added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class ConnectionStatus(hostname=None, state=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – FQDN or IP address of the configured remote logging servers. This +attribute was added in vSphere API 6.7.

    • +

  • state (Forwarding.ConnectionStatus.State) – State of the configured remote logging server. This attribute was +added in vSphere API 6.7.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage or None) – Message associated with the state of the configured remote logging +server. This attribute was added in vSphere API 6.7. +If None, there is no message to be shown.

    • +
+
+
+
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Forwarding.ConnectionStatus.State class defines the state values +that a remote logging server can be in. This enumeration was added in +vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+DOWN = State(string='DOWN')
+

The remote logging server is not reachable. This class attribute was added +in vSphere API 6.7.

+
+ +
+
+UNKNOWN = State(string='UNKNOWN')
+

The status of remote logging server is unknown. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+UP = State(string='UP')
+

The remote logging server is reachable. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+ +
+
+class Protocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Forwarding.Protocol class defines transport protocols for outbound +log messages. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Protocol instance.

+
+
+
+
+TCP = Protocol(string='TCP')
+

Log messages will be forwarded to the remote host using the TCP protocol. +This class attribute was added in vSphere API 6.7.

+
+ +
+
+TLS = Protocol(string='TLS')
+

Log messages will be forwarded to the remote host by using the TLS +protocol. This class attribute was added in vSphere API 6.7.

+
+ +
+
+UDP = Protocol(string='UDP')
+

Log messages will be forwarded to the remote host using the UDP protocol. +This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+get()
+

Returns the configuration for forwarding log messages to remote logging +servers. This method was added in vSphere API 6.7.

+
+
Return type
+

list of Forwarding.Config

+
+
Returns
+

Information about the configuration for forwarding log messages to +remote logging servers.

+
+
+
+ +
+
+set(cfg_list)
+

Sets the configuration for forwarding log messages to remote log +servers. This method was added in vSphere API 6.7.

+
+
Parameters
+

cfg_list (list of Forwarding.Config) – The cfgList is a list of Config structure that contains the log +message forwarding rules in terms of the host, port, protocol of +the log message.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if an invalid configuration is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the number of configurations exceeds the maximum number of +supported configurations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is any internal error during the execution of the +operation.

+
+
+
+ +
+
+test(send_test_message=None)
+

Validates the current log forwarding configuration by checking the +liveness of the remote machine and optionally sending a test diagnostic +log message from the appliance to all configured logging servers to +allow manual end-to-end validation. The message that is sent is: “This +is a diagnostic log test message from vCenter Server.”. This method was +added in vSphere API 6.7.

+
+
Parameters
+

send_test_message (bool or None) – Flag specifying whether a default test message should be sent to +the configured logging servers. +If None, no test message will be sent to the configured remote +logging servers.

+
+
Return type
+

list of Forwarding.ConnectionStatus

+
+
Returns
+

Information about the status of the connection to each of the +remote logging servers.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.logging_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.monitoring_client module

+

The com.vmware.appliance.monitoring_client module provides classes for +monitoring of the appliance. The module is available starting in vSphere 6.5.

+
+
+class com.vmware.appliance.monitoring_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.networking_client module

+

The com.vmware.appliance.networking_client module provides classes for +managing network configuration of the appliance. The module is available +starting in vSphere 6.5.

+
+
+class com.vmware.appliance.networking_client.Interfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Interfaces class provides methods Provides information about network +interface.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class InterfaceInfo(name=None, status=None, mac=None, ipv4=None, ipv6=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Interfaces.InterfaceInfo class Structure that defines properties and +status of a network interface.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class InterfaceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Interfaces.InterfaceStatus class Defines interface status

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the InterfaceStatus instance.

+
+
+
+
+down = InterfaceStatus(string='down')
+

The interface is down.

+
+ +
+
+up = InterfaceStatus(string='up')
+

The interface is up.

+
+ +
+ +
+
+get(interface_name)
+

Get information about a particular network interface.

+
+
Parameters
+

interface_name (str) – Network interface, for example, “nic0”. +The parameter must be an identifier for the resource type: +com.vmware.appliance.networking.interfaces.

+
+
Return type
+

Interfaces.InterfaceInfo

+
+
Returns
+

Network interface information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified interface is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+list()
+

Get list of available network interfaces, including those that are not +yet configured.

+
+
Return type
+

list of Interfaces.InterfaceInfo

+
+
Returns
+

List of InterfaceInfo structures.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking_client.NoProxy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The NoProxy class provides methods to configure a connection that does +not need a proxy. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Returns servers for which no proxy configuration will be applied. This +method was added in vSphere API 6.7.

+
+
Return type
+

list of str

+
+
Returns
+

List of servers for which no proxy configuration will be applied.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+set(servers)
+

Sets servers for which no proxy configuration should be applied. This +operation sets environment variables. In order for this operation to +take effect, a logout from appliance or a service restart is required. +If IPv4 is enabled, “127.0.0.1” and “localhost” will always bypass the +proxy (even if they are not explicitly configured). This method was +added in vSphere API 6.7.

+
+
Parameters
+

servers (list of str) – List of strings representing servers to bypass proxy. A server can +be a FQDN, IP address, FQDN:port or IP:port combinations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking_client.Proxy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Proxy class provides methods Proxy configuration. This class was +added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Config(server=None, port=None, username=None, password=None, enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Proxy.Config class defines proxy configuration. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server (str) – URL of the proxy server. This attribute was added in vSphere API +6.7.

    • +

  • port (long) – Port to connect to the proxy server. In a ‘get’ call, indicates the +port connected to the proxy server. In a ‘set’ call, specifies the +port to connect to the proxy server. A value of -1 indicates the +default port. This attribute was added in vSphere API 6.7.

    • +

  • username (str or None) – Username for proxy server. This attribute was added in vSphere API +6.7. +Only set if proxy requires username.

    • +

  • password (str or None) – Password for proxy server. This attribute was added in vSphere API +6.7. +Only set if proxy requires password.

    • +

  • enabled (bool) – In the result of the #get and #list methods this attribute +indicates whether proxying is enabled for a particular protocol. In +the input to the test and set methods this attribute +specifies whether proxying should be enabled for a particular +protocol. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Protocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Proxy.Protocol class defines the protocols for which proxying is +supported. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Protocol instance.

+
+
+
+
+FTP = Protocol(string='FTP')
+

Proxy configuration for ftp. This class attribute was added in vSphere API +6.7.

+
+ +
+
+HTTP = Protocol(string='HTTP')
+

Proxy configuration for http. This class attribute was added in vSphere API +6.7.

+
+ +
+
+HTTPS = Protocol(string='HTTPS')
+

Proxy configuration for https. This class attribute was added in vSphere +API 6.7.

+
+ +
+ +
+
+class ServerStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Proxy.ServerStatus class defines the status of the server associated +with the test run. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ServerStatus instance.

+
+
+
+
+SERVER_REACHABLE = ServerStatus(string='SERVER_REACHABLE')
+

Server is reachable. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SERVER_UNREACHABLE = ServerStatus(string='SERVER_UNREACHABLE')
+

Server is unreachable. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class TestResult(status=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Proxy.TestResult class contains information about the test +operation done on a proxy server. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+delete(protocol)
+

Deletes a proxy configuration for a specific protocol. This method was +added in vSphere API 6.7.

+
+
Parameters
+

protocol (str) – ID whose proxy is to be deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+get(protocol)
+

Gets the proxy configuration for a specific protocol. This method was +added in vSphere API 6.7.

+
+
Parameters
+

protocol (str) – The protocol whose proxy configuration is requested.

+
+
Return type
+

Proxy.Config

+
+
Returns
+

Proxy configuration for a specific protocol.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+list()
+

Gets proxy configuration for all configured protocols. This method was +added in vSphere API 6.7.

+
+
Return type
+

dict of Proxy.Protocol and Proxy.Config

+
+
Returns
+

Proxy configuration for all configured protocols.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+set(protocol, config)
+

Configures which proxy server to use for the specified protocol. This +operation sets environment variables for using proxy. In order for this +configuration to take effect a logout / service restart is required. +This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • protocol (str) – The protocol for which proxy should be set.

    • +

  • config (Proxy.Config) – Proxy configuration for the specific protocol.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+test(host, protocol, config)
+

Tests a proxy configuration by testing the connection to the proxy +server and test host. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • host (str) – A hostname, IPv4 or Ipv6 address.

    • +

  • protocol (str) – Protocol whose proxy is to be tested.

    • +

  • config (Proxy.Config) – Proxy configuration to test.

    • +
+
+
Return type
+

Proxy.TestResult

+
+
Returns
+

Status of proxy settings.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.ntp_client module

+

The com.vmware.appliance.ntp_client module provides classes for managing +NTP settings of the appliance. The module is available starting in vSphere 6.5.

+
+
+class com.vmware.appliance.ntp_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.recovery_client module

+

The com.vmware.appliance.recovery_client module provides classes for backin +up and restoring vCenter Appliance configuration. The module is available +starting in vSphere 6.7.

+
+
+class com.vmware.appliance.recovery_client.Backup(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Backup class provides methods Performs backup restore operations

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackupRequest(parts=None, backup_password=None, location_type=None, location=None, location_user=None, location_password=None, comment=None, fast_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Backup.BackupRequest class Structure representing requested backup +piece

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • parts (list of str) – a list of optional parts. Run backup parts APIs to get list of +optional parts and description

    • +

  • backup_password (str or None) – a password for a backup piece The backupPassword must adhere to the +following password requirements: At least 8 characters, cannot be +more than 20 characters in length. At least 1 uppercase letter. At +least 1 lowercase letter. At least 1 numeric digit. At least 1 +special character (i.e. any character not in [0-9,a-z,A-Z]). Only +visible ASCII characters (for example, no space). +backupPassword If no password then the piece will not be encrypted

    • +

  • location_type (Backup.LocationType) – a type of location

    • +

  • location (str) – path or url

    • +

  • location_user (str or None) – username for location +locationUser User name for this location if login is required.

    • +

  • location_password (str or None) – password for location +locationPassword Password for the specified user if login is +required at this location.

    • +

  • comment (str or None) – Custom comment +comment an optional comment

    • +

  • fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. +If None backup will proceed at slow rate

    • +
+
+
+
+ +
+
+class LocalizableMessage(id=None, default_message=None, args=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Backup.LocalizableMessage class Structure representing message

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – id in message bundle

    • +

  • default_message (str) – text in english

    • +

  • args (list of str) – nested data

    • +
+
+
+
+ +
+
+class LocationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Backup.LocationType class Defines type of all locations for +backup/restore

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LocationType instance.

+
+
+
+
+FTP = LocationType(string='FTP')
+

Destination is FTP server

+
+ +
+
+FTPS = LocationType(string='FTPS')
+

Destination is FTPS server

+
+ +
+
+HTTP = LocationType(string='HTTP')
+

Destination is HTTP server

+
+ +
+
+HTTPS = LocationType(string='HTTPS')
+

Destination is HTTPS server

+
+ +
+
+NFS = LocationType(string='NFS')
+

Destination is NFS server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+
+SCP = LocationType(string='SCP')
+

Destination is SSH server

+
+ +
+
+SFTP = LocationType(string='SFTP')
+

Destination is SFTP server

+
+ +
+
+SMB = LocationType(string='SMB')
+

Destination is SMB server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+ +
+
+class ReturnResult(status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Backup.ReturnResult class Structure representing precheck result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class ReturnStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Backup.ReturnStatus class Defines the state of precheck

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ReturnStatus instance.

+
+
+
+
+FAIL = ReturnStatus(string='FAIL')
+

Check failed

+
+ +
+
+OK = ReturnStatus(string='OK')
+

Check passed

+
+ +
+
+WARNING = ReturnStatus(string='WARNING')
+

Passed with warnings

+
+ +
+ +
+
+validate(piece)
+

Check for backup errors without starting backup.

+
+
Parameters
+

piece (Backup.BackupRequest) – BackupRequest Structure

+
+
Return type
+

Backup.ReturnResult

+
+
Returns
+

ReturnResult Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.FeatureInUse +A backup or restore is already in progress

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery_client.Restore(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Restore class provides methods Performs restore operations

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class LocalizableMessage(id=None, default_message=None, args=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Restore.LocalizableMessage class Structure representing message

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – id in message bundle

    • +

  • default_message (str) – text in english

    • +

  • args (list of str) – nested data

    • +
+
+
+
+ +
+
+class LocationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Restore.LocationType class Defines type of all locations for +backup/restore

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LocationType instance.

+
+
+
+
+FTP = LocationType(string='FTP')
+

Destination is FTP server

+
+ +
+
+FTPS = LocationType(string='FTPS')
+

Destination is FTPS server

+
+ +
+
+HTTP = LocationType(string='HTTP')
+

Destination is HTTP server

+
+ +
+
+HTTPS = LocationType(string='HTTPS')
+

Destination is HTTPS server

+
+ +
+
+NFS = LocationType(string='NFS')
+

Destination is NFS server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+
+SCP = LocationType(string='SCP')
+

Destination is SSH server

+
+ +
+
+SFTP = LocationType(string='SFTP')
+

Destination is SFTP server

+
+ +
+
+SMB = LocationType(string='SMB')
+

Destination is SMB server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+ +
+
+class Metadata(timestamp=None, parts=None, version=None, boxname=None, sso_login_required=None, comment=None, applicable=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Restore.Metadata class Structure representing metadata

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • timestamp (datetime.datetime) – Time when this backup was completed.

    • +

  • parts (list of str) – List of parts included in the backup.

    • +

  • version (str) – VCSA version

    • +

  • boxname (str) – Box name is PNID/ FQDN etc

    • +

  • sso_login_required (bool) – Is SSO login required for the vCenter server. This attribute was +added in vSphere API 6.7. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • comment (str) – Custom comment

    • +

  • applicable (bool) – Does the VCSA match the deployment type, network properties and +version of backed up VC

    • +

  • messages (list of Restore.LocalizableMessage) – Any messages if the backup is not aplicable

    • +
+
+
+
+ +
+
+class RestoreRequest(backup_password=None, location_type=None, location=None, location_user=None, location_password=None, sso_admin_user_name=None, sso_admin_user_password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Restore.RestoreRequest class Structure representing requested restore +piece

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backup_password (str or None) – a password for a backup piece +backupPassword If no password then the piece will not be decrypted

    • +

  • location_type (Restore.LocationType) – a type of location

    • +

  • location (str) – path or url

    • +

  • location_user (str or None) – username for location +locationUser User name for this location if login is required.

    • +

  • location_password (str or None) – password for location +locationPassword Password for the specified user if login is +required at this location.

    • +

  • sso_admin_user_name (str or None) – Administrators username for SSO. This attribute was added in +vSphere API 6.7. +If None SSO authentication will not be used. If the vCenter Server +is a management node or an embedded node, authentication is +required.

    • +

  • sso_admin_user_password (str or None) – The password for SSO admin user. This attribute was added in +vSphere API 6.7. +If None SSO authentication will not be used. If the vCenter Server +is a management node or an embedded node, authentication is +required.

    • +
+
+
+
+ +
+
+validate(piece)
+

Get metadata before restore

+
+
Parameters
+

piece (Restore.RestoreRequest) – RestoreRequest Structure

+
+
Return type
+

Restore.Metadata

+
+
Returns
+

Metadata Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.shutdown_client module

+

The com.vmware.appliance.shutdown_client module provides classes to +shutdown and reboot the appliance. The module is available starting in vSphere +6.5.

+
+
+class com.vmware.appliance.shutdown_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.support_bundle_client module

+
+
+class com.vmware.appliance.support_bundle_client.Components(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SupportBundleComponents class provides methods to get the supported +support bundle components. This class was added in vSphere API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get list of components/manifests included in the support bundle. +Manifests for a component specifies the files for a particular +component that all needs to be collected as part of support bundle. +This method was added in vSphere API 7.0.1.0.

+
+
Return type
+

dict of str and list of str

+
+
Returns
+

A map of components with it’s group. The keys in the map are group +names and values in the map are a list of components in the group.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.support_bundle_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.supportbundle_client module

+

The com.vmware.appliance.supportbundle_client module provides classes for +setting and getting support bundle related operations.

+
+
+class com.vmware.appliance.supportbundle_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.system_client module

+

The com.vmware.appliance.system_client module provides classes to query the +appliance system information. The module is available starting in vSphere 6.5.

+
+
+class com.vmware.appliance.system_client.Storage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Storage class provides methods Appliance storage configuration

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class StorageChange(old_size=None, new_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Storage.StorageChange class describes the changes in capasity of a +storage partition. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • old_size (long) – Original size of the partition in MB. This attribute was added in +vSphere API 6.7.

    • +

  • new_size (long) – Nedw size of the partition in MB. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+class StorageMapping(disk=None, partition=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Storage.StorageMapping class describes the mapping between VCSA +partitions and the Hard disk numbers visible in the vSphere Web Client.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • disk (str) – The disk number in the vSphere Web Client. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.system.storage. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.appliance.system.storage.

    • +

  • partition (str) – Storage partition name.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of partition. This attribute was added in vSphere API +6.7. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+list()
+

Get disk to partition mapping.

+
+
Return type
+

list of Storage.StorageMapping

+
+
Returns
+

list of mapping items

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+resize()
+

Resize all partitions to 100 percent of disk size.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+resize_ex()
+

Resize all partitions to 100 percent of disk size. This method was +added in vSphere API 6.7.

+
+
Return type
+

dict of str and Storage.StorageChange

+
+
Returns
+

List of the partitions with the size before and after resizing

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.system_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.system_client.Time(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Time class provides methods Gets system time.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class SystemTimeStruct(seconds_since_epoch=None, date=None, time=None, timezone=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Time.SystemTimeStruct class Structure representing the system time.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • seconds_since_epoch (float) – seconds since the epoch

    • +

  • date (str) – date format: Thu 07-31-2014

    • +

  • time (str) – time format: 18:18:32

    • +

  • timezone (str) – timezone

    • +
+
+
+
+ +
+
+get()
+

Get system time.

+
+
Return type
+

Time.SystemTimeStruct

+
+
Returns
+

System time

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.system_client.Uptime(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Uptime class provides methods Get the system uptime.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get the system uptime.

+
+
Return type
+

float

+
+
Returns
+

system uptime

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.system_client.Version(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Version class provides methods Get the appliance version.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class VersionStruct(version=None, product=None, build=None, type=None, summary=None, releasedate=None, install_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Version.VersionStruct class Structure representing appliance version +information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Appliance version.

    • +

  • product (str) – Appliance name.

    • +

  • build (str) – Appliance build number.

    • +

  • type (str) – Type of product. Same product can have different deployment +options, which is represented by type.

    • +

  • summary (str) – Summary of patch (empty string, if the appliance has not been +patched)

    • +

  • releasedate (str) – Release date of patch (empty string, if the appliance has not been +patched)

    • +

  • install_time (str) – Display the date and time when this system was first installed. +Value will not change on subsequent updates.

    • +
+
+
+
+ +
+
+get()
+

Get the version.

+
+
Return type
+

Version.VersionStruct

+
+
Returns
+

version information about the appliance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+

com.vmware.appliance.update_client module

+

The com.vmware.appliance.update_client module provides classes for updating +the software in the appliance. The module is available starting in vSphere 6.5.

+
+
+class com.vmware.appliance.update_client.CommonInfo(description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CommonInfo class defines common update information. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update +is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute +was added in vSphere API 6.7.

    • +

  • priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.

    • +

  • severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.

    • +

  • update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.

    • +

  • release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.

    • +

  • reboot_required (bool) – Flag indicating whether reboot is required after update. This +attribute was added in vSphere API 6.7.

    • +

  • size (long) – Download Size of update in Megabytes. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+
+class Category(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CommonInfo.Category class defines update type. This enumeration was +added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Category instance.

+
+
+
+
+FIX = Category(string='FIX')
+

Fixes bugs/vulnerabilities, doesn’t change functionality. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+SECURITY = Category(string='SECURITY')
+

Fixes vulnerabilities, doesn’t change functionality. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+UPDATE = Category(string='UPDATE')
+

Changes product functionality. This class attribute was added in vSphere +API 6.7.

+
+ +
+
+UPGRADE = Category(string='UPGRADE')
+

Introduces new features, significantly changes product functionality. This +class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class Priority(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CommonInfo.Priority class defines the update installation priority +recommendations. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Priority instance.

+
+
+
+
+HIGH = Priority(string='HIGH')
+

Install ASAP. This class attribute was added in vSphere API 6.7.

+
+ +
+
+LOW = Priority(string='LOW')
+

Install at your discretion. This class attribute was added in vSphere API +6.7.

+
+ +
+
+MEDIUM = Priority(string='MEDIUM')
+

Install at the earliest convenience. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+class Severity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CommonInfo.Severity class defines the severity of the issues fixed +in the update. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Severity instance.

+
+
+
+
+CRITICAL = Severity(string='CRITICAL')
+

Vulnerabilities that can be exploited by an unauthenticated attacker from +the Internet or those that break the guest/host Operating System isolation. +The exploitation results in the complete compromise of confidentiality, +integrity, and availability of user data and/or processing resources +without user interaction. Exploitation could be leveraged to propagate an +Internet worm or execute arbitrary code between Virtual Machines and/or the +Host Operating System. This class attribute was added in vSphere API 6.7.

+
+ +
+
+IMPORTANT = Severity(string='IMPORTANT')
+

Vulnerabilities that are not rated critical but whose exploitation results +in the complete compromise of confidentiality and/or integrity of user data +and/or processing resources through user assistance or by authenticated +attackers. This rating also applies to those vulnerabilities which could +lead to the complete compromise of availability when exploitation is by a +remote unauthenticated attacker from the Internet or through a breach of +virtual machine isolation. This class attribute was added in vSphere API +6.7.

+
+ +
+
+LOW = Severity(string='LOW')
+

All other issues that have a security impact. Vulnerabilities where +exploitation is believed to be extremely difficult, or where successful +exploitation would have minimal impact. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+MODERATE = Severity(string='MODERATE')
+

Vulnerabilities where the ability to exploit is mitigated to a significant +degree by configuration or difficulty of exploitation, but in certain +deployment scenarios could still lead to the compromise of confidentiality, +integrity, or availability of user data and/or processing resources. This +class attribute was added in vSphere API 6.7.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.update_client.Pending(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Pending class provides methods to manipulate pending updates. This +class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(name=None, contents=None, services_will_be_stopped=None, eulas=None, staged=None, knowledge_base=None, description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Pending.Info class contains the extended information about the +update. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the update. This attribute was added in vSphere API 6.7.

    • +

  • contents (list of com.vmware.vapi.std_client.LocalizableMessage) – List of the 1. issues addressed since previous/current version 2. +new features/improvements. This attribute was added in vSphere API +6.7.

    • +

  • services_will_be_stopped (list of ServiceInfo) – List of the services that will be stopped and restarted during the +update installation. This attribute was added in vSphere API 6.7.

    • +

  • eulas (list of com.vmware.vapi.std_client.LocalizableMessage) – List of EULAs. This list has multiple entries and can be dynamic +based on what we are actually installing. This attribute was added +in vSphere API 6.7.

    • +

  • staged (bool) – Is the update staged. This attribute was added in vSphere API 6.7.

    • +

  • knowledge_base (str) – URL for the knowledge base article describing this update. This +attribute was added in vSphere API 6.7.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update +is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute +was added in vSphere API 6.7.

    • +

  • priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.

    • +

  • severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.

    • +

  • update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.

    • +

  • release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.

    • +

  • reboot_required (bool) – Flag indicating whether reboot is required after update. This +attribute was added in vSphere API 6.7.

    • +

  • size (long) – Download Size of update in Megabytes. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+class PrecheckResult(check_time=None, estimated_time_to_install=None, estimated_time_to_rollback=None, reboot_required=None, issues=None, questions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Pending.PrecheckResult class contains estimates of how long it will +take install and rollback an update as well as a list of possible warnings +and problems with installing the update. This class was added in vSphere +API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check_time (datetime.datetime) – Time when this precheck was run. This attribute was added in +vSphere API 6.7.

    • +

  • estimated_time_to_install (long or None) – Rough estimate of time to install the update (minutes). This +attribute was added in vSphere API 6.7. +estimatedTimeToInstall If None N/A

    • +

  • estimated_time_to_rollback (long or None) – Rough estimate of time to rollback the update (minutes). This +attribute was added in vSphere API 6.7. +estimatedTimeToRollback If None N/A

    • +

  • reboot_required (bool) – Is reboot required to install the update. This attribute was added +in vSphere API 6.7.

    • +

  • issues (com.vmware.appliance_client.Notifications or None) – Lists of the issues and warnings. This attribute was added in +vSphere API 6.7. +issues If None N/A

    • +

  • questions (list of Pending.Question) – List of questions that must be answered to install the update. This +attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Question(data_item=None, text=None, description=None, type=None, allowed_values=None, regexp=None, default_answer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Pending.Question class describes a item of information that must be +provided by the user in order to install the update. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • data_item (str) – ID of the data item. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.applicance.update.pending.dataitem. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.applicance.update.pending.dataitem.

    • +

  • text (com.vmware.vapi.std_client.LocalizableMessage) – Label for the item to be used in GUI/CLI. This attribute was added +in vSphere API 6.7.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the item. This attribute was added in vSphere API +6.7.

    • +

  • type (Pending.Question.InputType) – How this field shoudl be represented in GUI or CLI. This attribute +was added in vSphere API 6.7.

    • +

  • allowed_values (list of str or None) – List of allowed values. This attribute was added in vSphere API +6.7. +allowedValues If None any value is valid.

    • +

  • regexp (str or None) – Regexp to validate the input. This attribute was added in vSphere +API 6.7. +regexp If None no validation will be performed.

    • +

  • default_answer (str or None) – Default answer. This attribute was added in vSphere API 6.7. +defaultAnswer If None then there is no default answer, so an +explicit answer must be provided

    • +
+
+
+
+
+class InputType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Pending.Question.InputType class defines representation of field +fields in GUI or CLI. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the InputType instance.

+
+
+
+
+BOOLEAN = InputType(string='BOOLEAN')
+

Yes/No,On/Off,Checkbox answer. This class attribute was added in vSphere +API 6.7.

+
+ +
+
+PASSWORD = InputType(string='PASSWORD')
+

Password (masked) answer. This class attribute was added in vSphere API +6.7.

+
+ +
+
+PLAIN_TEXT = InputType(string='PLAIN_TEXT')
+

plain text answer. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+ +
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Pending.SourceType class defines the supported types of sources of +updates. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+LAST_CHECK = SourceType(string='LAST_CHECK')
+

Do not perform a new check, return the previous result. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+LOCAL = SourceType(string='LOCAL')
+

Check the local sources, ISO devices, staged area. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+LOCAL_AND_ONLINE = SourceType(string='LOCAL_AND_ONLINE')
+

Check the local sources, ISO devices, staged area, then online repository +as stated in update policy. This class attribute was added in vSphere API +6.7.

+
+ +
+ +
+
+get(version)
+

Gets update information. This method was added in vSphere API 6.7.

+
+
Parameters
+

version (str) – Update version +The parameter must be an identifier for the resource type: +com.vmware.appliance.update.pending.

+
+
Return type
+

Pending.Info

+
+
Returns
+

Update

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +the update is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the update of this version is already installed

+
+
+
+ +
+
+install(version, user_data)
+

Starts operation of installing the appliance update. Will fail is the +update is not staged. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • version (str) – Update version +The parameter must be an identifier for the resource type: +com.vmware.appliance.update.pending.

    • +

  • user_data (dict of str and str) – map of user provided data with IDs +The key in the parameter dict must be an identifier for +the resource type: +com.vmware.applicance.update.pending.dataitem.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the update of this version is already installed

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance update state prevents running an update or not staged

+
+
+
+ +
+
+list(source_type, url=None, enable_list_major_upgrade_versions=None)
+

Checks if there are any eligible updates. This method was added in +vSphere API 6.7.

+
+
Parameters
+
    +

  • source_type (Pending.SourceType) – type of the source

    • +

  • url (str or None) – specific URL to check at +If None then URL is taken from the policy settings

    • +

  • enable_list_major_upgrade_versions (bool or None) – checks and lists if there are eligible major version upgrades +available. Possible values are true and false +when set to true it allows listing of across version upgrade When +not specified lists only minor updates available

    • +
+
+
Return type
+

list of Summary

+
+
Returns
+

List of the update summaries

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +source is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
+
+ +
+
+precheck(version)
+

Runs update precheck. This method was added in vSphere API 6.7.

+
+
Parameters
+

version (str) – Update version +The parameter must be an identifier for the resource type: +com.vmware.appliance.update.pending.

+
+
Return type
+

Pending.PrecheckResult

+
+
Returns
+

PrecheckResult

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +the update is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if this version is already installed

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if another operation is in progress

+
+
+
+ +
+
+rollback()
+

Starts the update rollback operation such that the vCenter is reverted +to a state before update installation. It will remove any changes done +by update-install operation on the vCenter.

+

Caution: This operation will perform a reboot of appliance.. This +method was added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no valid snapshot present on the vCenter

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance update state prevents running a rollback operation

+
+
+
+ +
+
+stage(version)
+

Starts staging the appliance update. The updates are searched for in +the following order: staged, CDROM, URL. This method was added in +vSphere API 6.7.

+
+
Parameters
+

version (str) – Update version +The parameter must be an identifier for the resource type: +com.vmware.appliance.update.pending.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +the update is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the update of this version is already installed

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +the update is already staged

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance update state prevents staging

+
+
+
+ +
+
+stage_and_install(version, user_data)
+

Starts operation of installing the appliance update. Will stage update +if not already staged The updates are searched for in the following +order: staged, CDROM, URL. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • version (str) – Update version +The parameter must be an identifier for the resource type: +com.vmware.appliance.update.pending.

    • +

  • user_data (dict of str and str) – map of user provided data with IDs +The key in the parameter dict must be an identifier for +the resource type: +com.vmware.applicance.update.pending.dataitem.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the update of this version is already installed

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance update state prevents running an update

+
+
+
+ +
+
+validate(version, user_data)
+

Validates the user provided data before the update installation. This +method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • version (str) – Update version +The parameter must be an identifier for the resource type: +com.vmware.appliance.update.pending.

    • +

  • user_data (dict of str and str) – map of user provided data with IDs +The key in the parameter dict must be an identifier for +the resource type: +com.vmware.applicance.update.pending.dataitem.

    • +
+
+
Return type
+

com.vmware.appliance_client.Notifications

+
+
Returns
+

Issues struct with the issues found during the validation

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the update of this version is already installed

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance update state prevents running an check

+
+
+
+ +
+ +
+
+class com.vmware.appliance.update_client.Policy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Policy class provides methods to set/get background check for the +new updates. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Config(custom_url=None, username=None, password=None, check_schedule=None, auto_stage=None, certificate_check=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.Config class defines automatic update checking and staging +policy. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • custom_url (str or None) – Current appliance update repository URL. This attribute was added +in vSphere API 6.7. +If None then default URL is assumed

    • +

  • username (str or None) – Username for the update repository. This attribute was added in +vSphere API 6.7. +If None username will not be used to login

    • +

  • password (str or None) – Password for the update repository. This attribute was added in +vSphere API 6.7. +password If None password will not be used to login

    • +

  • check_schedule (list of Policy.Time) – Schedule when the automatic check will be run. This attribute was +added in vSphere API 6.7.

    • +

  • auto_stage (bool) – Automatically stage the latest update if available. This attribute +was added in vSphere API 6.7.

    • +

  • certificate_check (bool or None) –

    Indicates whether certificates will be checked during patching.

    +

    Warning: Setting this attribute to false will result in an insecure +connection to update repository which can potentially put the +appliance security at risk.. This attribute was added in vSphere +API 6.7. +certificateCheck If None the certificate checks are enabled.

    +

    • +
+
+
+
+ +
+
+class DayOfWeek(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Policy.DayOfWeek class defines the set of days. This enumeration +was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DayOfWeek instance.

+
+
+
+
+FRIDAY = DayOfWeek(string='FRIDAY')
+

Friday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+MONDAY = DayOfWeek(string='MONDAY')
+

Monday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SATURDAY = DayOfWeek(string='SATURDAY')
+

Saturday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SUNDAY = DayOfWeek(string='SUNDAY')
+

Sunday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+THURSDAY = DayOfWeek(string='THURSDAY')
+

Thursday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+TUESDAY = DayOfWeek(string='TUESDAY')
+

Tuesday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+WEDNESDAY = DayOfWeek(string='WEDNESDAY')
+

Wednesday. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class Info(custom_url=None, default_url=None, username=None, check_schedule=None, auto_stage=None, auto_update=None, manual_control=None, certificate_check=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.Info class defines automatic update checking and staging +policy. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • custom_url (str or None) – Current appliance update custom repository URL. This attribute was +added in vSphere API 6.7. +If None update is checked at defaut URL.

    • +

  • default_url (str) – Current appliance update default repository URL. This attribute was +added in vSphere API 6.7.

    • +

  • username (str or None) – Username for the update repository. This attribute was added in +vSphere API 6.7. +If None username will not be used to login

    • +

  • check_schedule (list of Policy.Time) – Schedule when the automatic check will be run. This attribute was +added in vSphere API 6.7.

    • +

  • auto_stage (bool) – Automatically stage the latest update if available. This attribute +was added in vSphere API 6.7.

    • +

  • auto_update (bool) – Is the appliance updated automatically. If set the +appliance may ignore the check schedule or auto-stage settings. +This attribute was added in vSphere API 6.7.

    • +

  • manual_control (bool) – Whether API client should allow the user to start update manually. +This attribute was added in vSphere API 6.7.

    • +

  • certificate_check (bool) –

    Indicates whether certificates will be checked during patching.

    +

    Warning: If this attribute is set to false, an insecure connection +is made to the update repository which can potentially put the +appliance security at risk.. This attribute was added in vSphere +API 6.7.

    +

    • +
+
+
+
+ +
+
+class Time(day=None, hour=None, minute=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.Time class defines weekday and time the automatic check for +new updates will be run. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • day (Policy.DayOfWeek) – weekday to check for updates. This attribute was added in vSphere +API 6.7.

    • +

  • hour (long) – Hour: 0-24. This attribute was added in vSphere API 6.7.

    • +

  • minute (long) – Minute: 0-59. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+get()
+

Gets the automatic update checking and staging policy. This method was +added in vSphere API 6.7.

+
+
Return type
+

Policy.Info

+
+
Returns
+

Structure containing the policy for the appliance update.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
+
+ +
+
+set(policy)
+

Sets the automatic update checking and staging policy. This method was +added in vSphere API 6.7.

+
+
Parameters
+

policy (Policy.Config) – Info structure containing the policy for the appliance update.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
+
+ +
+ +
+
+class com.vmware.appliance.update_client.ServiceInfo(service=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServiceInfo class describes a service to be stopped and started +during the update installation. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • service (str) – Service ID. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.service. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.appliance.service.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Service description. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.update_client.Staged(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Staged class provides methods to get the status of the staged +update. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(staging_complete=None, version=None, name=None, description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Staged.Info class contains information about the staged update. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • staging_complete (bool) – Is staging complete. This attribute was added in vSphere API 6.7.

    • +

  • version (str) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was +added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.update.pending. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.appliance.update.pending.

    • +

  • name (str) – Name of the update. This attribute was added in vSphere API 6.7.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update +is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute +was added in vSphere API 6.7.

    • +

  • priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.

    • +

  • severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.

    • +

  • update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.

    • +

  • release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.

    • +

  • reboot_required (bool) – Flag indicating whether reboot is required after update. This +attribute was added in vSphere API 6.7.

    • +

  • size (long) – Download Size of update in Megabytes. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+delete()
+

Deletes the staged update. This method was added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
+
+ +
+
+get()
+

Gets the current status of the staged update. This method was added in +vSphere API 6.7.

+
+
Return type
+

Staged.Info

+
+
Returns
+

Info structure with information about staged update

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if nothing is staged

+
+
+
+ +
+ +
+
+class com.vmware.appliance.update_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.update_client.Summary(version=None, name=None, description=None, priority=None, severity=None, update_type=None, release_date=None, reboot_required=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Summary class contains the essential information about the update. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was +added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.update.pending. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.appliance.update.pending.

    • +

  • name (str) – Name of the update. This attribute was added in vSphere API 6.7.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the update. The short information what this update +is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute +was added in vSphere API 6.7.

    • +

  • priority (CommonInfo.Priority) – Update priority. This attribute was added in vSphere API 6.7.

    • +

  • severity (CommonInfo.Severity) – Update severity. This attribute was added in vSphere API 6.7.

    • +

  • update_type (CommonInfo.Category) – Update category. This attribute was added in vSphere API 6.7.

    • +

  • release_date (datetime.datetime) – Update release date. This attribute was added in vSphere API 6.7.

    • +

  • reboot_required (bool) – Flag indicating whether reboot is required after update. This +attribute was added in vSphere API 6.7.

    • +

  • size (long) – Download Size of update in Megabytes. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.vmon_client module

+

The com.vmware.appliance.vmon_client module provides classes to manage a +set of services that are part of the vCenter Server.

+
+
+class com.vmware.appliance.vmon_client.Service(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Service class provides methods to manage a single/set of services +that are managed by vMon.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service.Health class defines the possible values for health of a +service.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+DEGRADED = Health(string='DEGRADED')
+

Service is in degraded state, it is not functional.

+
+ +
+
+HEALTHY = Health(string='HEALTHY')
+

Service is in a healthy state and is fully functional.

+
+ +
+
+HEALTHY_WITH_WARNINGS = Health(string='HEALTHY_WITH_WARNINGS')
+

Service is healthy with warnings.

+
+ +
+ +
+
+class Info(name_key=None, description_key=None, startup_type=None, state=None, health=None, health_messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Service.Info class contains information about a service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class StartupType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service.StartupType class defines valid Startup Type for services +managed by vMon.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StartupType instance.

+
+
+
+
+AUTOMATIC = StartupType(string='AUTOMATIC')
+

Service Startup type is Automatic, thus during starting all services or +issuing explicit start on the service will start it.

+
+ +
+
+DISABLED = StartupType(string='DISABLED')
+

Service Startup type is Disabled, thus it will not start unless the startup +type changes to manual or automatic.

+
+ +
+
+MANUAL = StartupType(string='MANUAL')
+

Service Startup type is Manual, thus issuing an explicit start on the +service will start it.

+
+ +
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service.State class defines valid Run State for services.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+STARTED = State(string='STARTED')
+

Service Run State is Started, it is fully functional

+
+ +
+
+STARTING = State(string='STARTING')
+

Service Run State is Starting, it is still not functional

+
+ +
+
+STOPPED = State(string='STOPPED')
+

Service Run State is Stopped

+
+ +
+
+STOPPING = State(string='STOPPING')
+

Service Run State is Stopping, it is not functional

+
+ +
+ +
+
+class UpdateSpec(startup_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Service.UpdateSpec class describes the changes to be made to the +configuration of the service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

startup_type (Service.StartupType or None) – Startup Type +If unspecified, leaves value unchanged.

+
+
+
+ +
+
+get(service)
+

Returns the state of a service.

+
+
Parameters
+

service (str) – identifier of the service whose state is being queried. +The parameter must be an identifier for the resource type: +com.vmware.appliance.vmon.Service.

+
+
Return type
+

Service.Info

+
+
Returns
+

Service Info structure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+list_details()
+

Lists details of services managed by vMon.

+
+
Return type
+

dict of str and Service.Info

+
+
Returns
+

Map of service identifiers to service Info structures. +The key in the return value dict will be an identifier for +the resource type: com.vmware.appliance.vmon.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+restart(service)
+

Restarts a service

+
+
Parameters
+

service (str) – identifier of the service to restart +The parameter must be an identifier for the resource type: +com.vmware.appliance.vmon.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if any timeout occurs during the execution of the restart +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop or start operation is in progress, issuing a restart +operation will lead to this error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a restart operation is issued on a service which has startup +type Service.StartupType.DISABLED

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+start(service)
+

Starts a service

+
+
Parameters
+

service (str) – identifier of the service to start +The parameter must be an identifier for the resource type: +com.vmware.appliance.vmon.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop or restart operation is in progress, the start operation +will not be allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if start operation is issued on a service which has startup type +Service.StartupType.DISABLED.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if any timeout occurs during the execution of the start operation. +Timeout occurs when the service takes longer than StartTimeout to +start.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+stop(service)
+

Stops a service

+
+
Parameters
+

service (str) – identifier of the service to stop +The parameter must be an identifier for the resource type: +com.vmware.appliance.vmon.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop operation is in progress, issuing another stop operation +will lead to this error.

+
+
+
+ +
+
+update(service, spec)
+

Updates the properties of a service.

+
+
Parameters
+
    +

  • service (str) – identifier of the service whose properties are being updated. +The parameter must be an identifier for the resource type: +com.vmware.appliance.vmon.Service.

    • +

  • spec (Service.UpdateSpec) – Service Update specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a start, stop or restart operation is in progress, update operation +will fail with this error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a request to set the Service.UpdateSpec.startup_type +attribute of spec to Service.StartupType.DISABLED comes +in for a service that is not in Service.State.STOPPED +state.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.vmon_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.networking.html b/vsphere/8.0.2.0/com.vmware.appliance.networking.html new file mode 100644 index 00000000..cece89c1 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.networking.html @@ -0,0 +1,1381 @@ + + + + + + + com.vmware.appliance.networking package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance.networking package

+
+

Submodules

+
+
+

com.vmware.appliance.networking.dns_client module

+
+
+class com.vmware.appliance.networking.dns_client.Domains(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Domains class provides methods DNS search domains.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+add(domain)
+

Add domain to DNS search domains.

+
+
Parameters
+

domain (str) – Domain to add.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+list()
+

Get list of DNS search domains.

+
+
Return type
+

list of str

+
+
Returns
+

List of domains.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(domains)
+

Set DNS search domains.

+
+
Parameters
+

domains (list of str) – List of domains.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking.dns_client.Hostname(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Hostname class provides methods Performs operations on Fully Qualified +Doman Name.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Message(message=None, result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Hostname.Message class Test result and message

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class MessageStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Hostname.MessageStatus class Individual test result

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MessageStatus instance.

+
+
+
+
+failure = MessageStatus(string='failure')
+

message indicates the test failed.

+
+ +
+
+success = MessageStatus(string='success')
+

message indicates that the test was successful.

+
+ +
+ +
+
+class TestStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Hostname.TestStatus class Health indicator

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the TestStatus instance.

+
+
+
+
+green = TestStatus(string='green')
+

All tests were successful for given data

+
+ +
+
+orange = TestStatus(string='orange')
+

In case data has more than one test, this indicates not all tests were +successful

+
+ +
+
+red = TestStatus(string='red')
+

All tests failed for given data

+
+ +
+ +
+
+class TestStatusInfo(status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Hostname.TestStatusInfo class Overall test result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+get()
+

Get the Fully Qualified Doman Name.

+
+
Return type
+

str

+
+
Returns
+

FQDN.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(name)
+

Set the Fully Qualified Domain Name.

+
+
Parameters
+

name (str) – FQDN.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+test(name)
+

Test the Fully Qualified Domain Name.

+
+
Parameters
+

name (str) – FQDN.

+
+
Return type
+

Hostname.TestStatusInfo

+
+
Returns
+

FQDN status

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking.dns_client.Servers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Servers class provides methods DNS server configuration.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DNSServerConfig(mode=None, servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Servers.DNSServerConfig class This structure represents the +configuration state used to determine DNS servers.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mode (Servers.DNSServerMode) – Define how to determine the DNS servers. Leave the servers argument +empty if the mode argument is “DHCP”. Set the servers argument to a +comma-separated list of DNS servers if the mode argument is +“static”. The DNS server are assigned from the specified list.

    • +

  • servers (list of str) – List of the currently used DNS servers.

    • +
+
+
+
+ +
+
+class DNSServerMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Servers.DNSServerMode class Describes DNS Server source (DHCP,static)

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DNSServerMode instance.

+
+
+
+
+dhcp = DNSServerMode(string='dhcp')
+

DNS address is automatically assigned by a DHCP server.

+
+ +
+
+is_static = DNSServerMode(string='is_static')
+

DNS address is static.

+
+ +
+ +
+
+class Message(message=None, result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Servers.Message class Test result and message

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class MessageStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Servers.MessageStatus class Individual test result

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MessageStatus instance.

+
+
+
+
+failure = MessageStatus(string='failure')
+

message indicates the test failed.

+
+ +
+
+success = MessageStatus(string='success')
+

message indicates that the test was successful.

+
+ +
+ +
+
+class TestStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Servers.TestStatus class Health indicator

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the TestStatus instance.

+
+
+
+
+green = TestStatus(string='green')
+

All tests were successful for given data

+
+ +
+
+orange = TestStatus(string='orange')
+

In case data has more than one test, this indicates not all tests were +successful

+
+ +
+
+red = TestStatus(string='red')
+

All tests failed for given data

+
+ +
+ +
+
+class TestStatusInfo(status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Servers.TestStatusInfo class Overall test result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+add(server)
+

Add a DNS server. This method fails if mode argument is “dhcp”

+
+
Parameters
+

server (str) – DNS server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+get()
+

Get DNS server configuration.

+
+
Return type
+

Servers.DNSServerConfig

+
+
Returns
+

DNS server configuration.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(config)
+

Set the DNS server configuration. If you set the mode argument to +“DHCP”, a DHCP refresh is forced.

+
+
Parameters
+

config (Servers.DNSServerConfig) – DNS server configuration.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+test(servers)
+

Test if dns servers are reachable.

+
+
Parameters
+

servers (list of str) – DNS servers.

+
+
Return type
+

Servers.TestStatusInfo

+
+
Returns
+

DNS reacable status

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking.dns_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.networking.firewall_client module

+
+
+class com.vmware.appliance.networking.firewall_client.Inbound(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Inbound class provides methods to manage inbound firewall rules. +This class was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Policy(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Inbound.Policy class Defines firewall rule policies. This enumeration +was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Policy instance.

+
+
+
+
+ACCEPT = Policy(string='ACCEPT')
+

Allow packet with corresponding address. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+IGNORE = Policy(string='IGNORE')
+

Drop packet with correpsonding address. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+REJECT = Policy(string='REJECT')
+

Drop packet with corresponding address sending destination is not +reachable. This class attribute was added in vSphere API 6.7.1.

+
+ +
+
+RETURN = Policy(string='RETURN')
+

Apply default or port-specific rules to packet with corresponding address. +This class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+class Rule(address=None, prefix=None, policy=None, interface_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Inbound.Rule class Structure that defines a single address-based +firewall rule. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IPv4 or IPv6 address. This attribute was added in vSphere API +6.7.1.

    • +

  • prefix (long) – CIDR prefix used to mask address. For example, an IPv4 prefix of 24 +ignores the low-order 8 bits of address. This attribute was added +in vSphere API 6.7.1.

    • +

  • policy (Inbound.Policy) – The allow or deny policy of this rule. This attribute was added in +vSphere API 6.7.1.

    • +

  • interface_name (str or None) – The interface to which this rule applies. An empty string indicates +that the rule applies to all interfaces. This attribute was added +in vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+get()
+

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 +connection stops, and the appliance ignores any additional firewall +rules you have set. This method was added in vSphere API 6.7.1.

+
+
Return type
+

list of Inbound.Rule

+
+
Returns
+

List of address-based firewall rules.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(rules)
+

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:

+ ++++++ + + + + + + + + + + + + + + + + + + + +

Address

Prefix

Interface Name

Policy

10.112.0.1

0

*

REJECT

10.112.0.1

0

nic0

ACCEPT

+

In the above example, the first rule drops all packets originating from +10.112.0.1 and +the second rule accepts all packets originating from 10.112.0.1 only on +nic0. In effect, the second rule is always ignored which is not +desired, hence the order has to be swapped. When a connection matches a +firewall rule, further processing for the connection stops, and the +appliance ignores any additional firewall rules you have set. This +method was added in vSphere API 6.7.1.

+
+
Parameters
+

rules (list of Inbound.Rule) – List of address-based firewall rules.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking.firewall_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.networking.interfaces_client module

+
+
+class com.vmware.appliance.networking.interfaces_client.Ipv4(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Ipv4 class provides methods to perform IPv4 network configuration +for interfaces. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Config(mode=None, address=None, prefix=None, default_gateway=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv4.Config class provides defines the IPv4 configuration of a +network interface. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mode (Ipv4.Mode) – The Address assignment mode. This attribute was added in vSphere +API 6.7.

    • +

  • address (str) – The IPv4 address, for example, “10.20.80.191”. This attribute was +added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of mode is Ipv4.Mode.STATIC.

    • +

  • prefix (long) – The IPv4 CIDR prefix, for example, 24. See +http://www.oav.net/mirrors/cidr.html for netmask-to-prefix +conversion. This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of mode is Ipv4.Mode.STATIC.

    • +

  • default_gateway (str or None) – The IPv4 address of the default gateway. This configures the global +default gateway on the appliance with the specified gateway address +and interface. This gateway replaces the existing default gateway +configured on the appliance. However, if the gateway address is +link-local, then it is added for that interface. This does not +support configuration of multiple global default gateways through +different interfaces. This attribute was added in vSphere API 6.7. +If None, the defaultGateway was never set.

    • +
+
+
+
+ +
+
+class Info(configurable=None, mode=None, address=None, prefix=None, default_gateway=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv4.Info class defines current IPv4 configuration state of a +network interface. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • configurable (bool) – The specified network interface is configurable or not. This +attribute was added in vSphere API 6.7.

    • +

  • mode (Ipv4.Mode) – The Address assignment mode. This attribute was added in vSphere +API 6.7.

    • +

  • address (str) – The IPv4 address, for example, “10.20.80.191”. This attribute was +added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of mode is one of Ipv4.Mode.STATIC or +Ipv4.Mode.DHCP.

    • +

  • prefix (long) – The IPv4 CIDR prefix, for example, 24. See +http://www.oav.net/mirrors/cidr.html for netmask-to-prefix +conversion. This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of mode is one of Ipv4.Mode.STATIC or +Ipv4.Mode.DHCP.

    • +

  • default_gateway (str) – The IPv4 address of the default gateway. This configures the global +default gateway on the appliance with the specified gateway address +and interface. This gateway replaces the existing default gateway +configured on the appliance. However, if the gateway address is +link-local, then it is added for that interface. This does not +support configuration of multiple global default gateways through +different interfaces. This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of mode is one of Ipv4.Mode.STATIC or +Ipv4.Mode.DHCP.

    • +
+
+
+
+ +
+
+class Mode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ipv4.Mode class defines different IPv4 address assignment modes. +This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Mode instance.

+
+
+
+
+DHCP = Mode(string='DHCP')
+

The IPv4 address is automatically assigned by a DHCP server. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+STATIC = Mode(string='STATIC')
+

The IPv4 address is static. This class attribute was added in vSphere API +6.7.

+
+ +
+
+UNCONFIGURED = Mode(string='UNCONFIGURED')
+

The IPv4 protocol is not configured. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+get(interface_name)
+

Get IPv4 network configuration for specific NIC. This method was added +in vSphere API 6.7.

+
+
Parameters
+

interface_name (str) – The Network interface to query, for example, “nic0”. +The parameter must be an identifier for the resource type: +com.vmware.appliance.networking.interfaces.

+
+
Return type
+

Ipv4.Info

+
+
Returns
+

The IPv4 configuration for the queried NIC.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified NIC is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+set(interface_name, config)
+

Set IPv4 network configuration for specific network interface. This +method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • interface_name (str) – Network interface to update, for example, “nic0”. +The parameter must be an identifier for the resource type: +com.vmware.appliance.networking.interfaces.

    • +

  • config (Ipv4.Config) – The IPv4 Network configuration to set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified NIC is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the IP is used as PNID

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the specified NIC is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking.interfaces_client.Ipv6(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Ipv6 class provides methods to perform IPv6 network configuration +for interfaces. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Address(address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6.Address class provides the structure used to name an IPv6 +address. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a. +This attribute was added in vSphere API 6.7.

    • +

  • prefix (long) – The IPv6 CIDR prefix, for example, 64. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+class AddressInfo(origin=None, status=None, address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6.AddressInfo class provides the structure that you can use to +get information about an IPv6 address along with its origin and status. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • origin (Ipv6.Origin) – The Origin of the IPv6 address. For more information, see RFC 4293. +This attribute was added in vSphere API 6.7.

    • +

  • status (Ipv6.Status) – The Status of the IPv6 address. For more information, see RFC 4293. +This attribute was added in vSphere API 6.7.

    • +

  • address (str) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a. +This attribute was added in vSphere API 6.7.

    • +

  • prefix (long) – The IPv6 CIDR prefix, for example, 64. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Config(dhcp=None, autoconf=None, addresses=None, default_gateway=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6.Config class provides the structure that you can use to +configure IPv6 on a particular interface. Addresses can be assigned by +DHCP, SLAAC or STATIC, as IPv6 permits multiple addresses per interface. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dhcp (bool) – An address will be assigned by a DHCP server. This attribute was +added in vSphere API 6.7.

    • +

  • autoconf (bool) – An address will be assigned by Stateless Address Autoconfiguration +(SLAAC). This attribute was added in vSphere API 6.7.

    • +

  • addresses (list of Ipv6.Address) – The list of addresses to be statically assigned. This attribute was +added in vSphere API 6.7.

    • +

  • default_gateway (str) – The default gateway for static IP address assignment. This +configures the global IPv6 default gateway on the appliance with +the specified gateway address and interface. This gateway replaces +the existing default gateway configured on the appliance. However, +if the gateway address is link-local, then it is added for that +interface. This does not support configuration of multiple global +default gateways through different interfaces. This attribute was +added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Info(dhcp=None, autoconf=None, addresses=None, default_gateway=None, configurable=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6.Info class provides the structure that defines an existing +IPv6 configuration on a particular interface. This structure is read only. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dhcp (bool) – DHCP is on. This attribute was added in vSphere API 6.7.

    • +

  • autoconf (bool) – Stateless Address Autoconfiguration (SLAAC) is on. This attribute +was added in vSphere API 6.7.

    • +

  • addresses (list of Ipv6.AddressInfo) – List of addresses with their origins and statuses. This attribute +was added in vSphere API 6.7.

    • +

  • default_gateway (str) – The default gateway for static IP address assignment. This +configures the global IPv6 default gateway on the appliance with +the specified gateway address and interface. This gateway replaces +the existing default gateway configured on the appliance. However, +if the gateway address is link-local, then it is added for that +interface. This does not support configuration of multiple global +default gateways through different interfaces. This attribute was +added in vSphere API 6.7.

    • +

  • configurable (bool) – Is NIC configurable or not. This attribute was added in vSphere API +6.7.

    • +
+
+
+
+ +
+
+class Origin(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ipv6.Origin class defines IPv6 address origin values. This +enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Origin instance.

+
+
+
+
+DHCP = Origin(string='DHCP')
+

The IPv6 address is assigned by a DHCP server. See RFC 4293. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+LINKLAYER = Origin(string='LINKLAYER')
+

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.

+
+ +
+
+MANUAL = Origin(string='MANUAL')
+

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.

+
+ +
+
+OTHER = Origin(string='OTHER')
+

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.

+
+ +
+
+RANDOM = Origin(string='RANDOM')
+

The IPv6 address is assigned randomly by the system. See RFC 4293. This +class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ipv6.Status class defines IPv6 address status values. See RFC 4293. +This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+DEPRECATED = Status(string='DEPRECATED')
+

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 +vSphere API 6.7.

+
+ +
+
+DUPLICATE = Status(string='DUPLICATE')
+

The IPv6 address is not unique on the link and cannot be used. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+INACCESSIBLE = Status(string='INACCESSIBLE')
+

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.

+
+ +
+
+INVALID = Status(string='INVALID')
+

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.

+
+ +
+
+OPTIMISTIC = Status(string='OPTIMISTIC')
+

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.

+
+ +
+
+PREFERRED = Status(string='PREFERRED')
+

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.

+
+ +
+
+TENTATIVE = Status(string='TENTATIVE')
+

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 +vSphere API 6.7.

+
+ +
+
+UNKNOWN = Status(string='UNKNOWN')
+

The status of this address cannot be determined. This class attribute was +added in vSphere API 6.7.

+
+ +
+ +
+
+get(interface_name)
+

Get IPv6 network configuration for specific interface. This method was +added in vSphere API 6.7.

+
+
Parameters
+

interface_name (str) – Network interface to query, for example, “nic0”. +The parameter must be an identifier for the resource type: +com.vmware.appliance.networking.interfaces.

+
+
Return type
+

Ipv6.Info

+
+
Returns
+

IPv6 configuration.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified NIC is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+set(interface_name, config)
+

Set IPv6 network configuration for specific interface. This method was +added in vSphere API 6.7.

+
+
Parameters
+
    +

  • interface_name (str) – Network interface to update, for example, “nic0”. +The parameter must be an identifier for the resource type: +com.vmware.appliance.networking.interfaces.

    • +

  • config (Ipv6.Config) – The IPv6 configuration.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +The specified NIC is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +The specified NIC is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.networking.interfaces_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.recovery.backup.html b/vsphere/8.0.2.0/com.vmware.appliance.recovery.backup.html new file mode 100644 index 00000000..725852b6 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.recovery.backup.html @@ -0,0 +1,578 @@ + + + + + + + com.vmware.appliance.recovery.backup package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance.recovery.backup package

+
+

Submodules

+
+
+

com.vmware.appliance.recovery.backup.job_client module

+
+
+class com.vmware.appliance.recovery.backup.job_client.Details(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Details class provides methods to get the details about backup +jobs. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BuildInfo(version_name=None, version=None, build_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Details.BuildInfo class contains information about the build of the +appliance. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version_name (str) – Appliance product type, for example 6.8.2 GA. This attribute was +added in vSphere API 6.7.2.

    • +

  • version (str) – Appliance version, for example 6.8.2.10000. This attribute was +added in vSphere API 6.7.2.

    • +

  • build_number (str) – Build Number of the appliance. This attribute was added in vSphere +API 6.7.2.

    • +
+
+
+
+ +
+
+class FilterSpec(jobs=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Details.FilterSpec class contains attributes used to filter the +results when listing backup jobs details (see Details.list()). This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

jobs (set of str or None) – Identifiers of backup jobs that can match the filter. This +attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.recovery.backup.job. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.appliance.recovery.backup.job. +If None the filter will match all the backup jobs.

+
+
+
+ +
+
+class Info(location=None, duration=None, size=None, progress=None, location_user=None, type=None, messages=None, build=None, fast_backup=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Details.Info class contains information about a backup job. This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • location (str) – URL of the backup location. This attribute was added in vSphere API +6.7.

    • +

  • duration (long) – Time in seconds since the backup job was started or the time it +took to complete the backup job. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.SUCCEEDED, +com.vmware.cis.task_client.Status.FAILED, or +com.vmware.cis.task_client.Status.RUNNING.

    • +

  • size (long) – Size of the backup data transferred to remote location. This +attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.SUCCEEDED, +com.vmware.cis.task_client.Status.FAILED, or +com.vmware.cis.task_client.Status.RUNNING.

    • +

  • progress (com.vmware.cis.task_client.Progress) – Progress of the job. This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.SUCCEEDED, +com.vmware.cis.task_client.Status.FAILED, or +com.vmware.cis.task_client.Status.RUNNING.

    • +

  • location_user (str) – The username for the remote backup location. This attribute was +added in vSphere API 6.7.

    • +

  • type (Details.Type) – Type of the backup job. Indicates whether the backup was started +manually or as a scheduled backup. This attribute was added in +vSphere API 6.7.

    • +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) – List of any info/warning/error messages returned by the backup job. +This attribute was added in vSphere API 6.7.

    • +

  • build (Details.BuildInfo) – Information about the build of the appliance. This attribute was +added in vSphere API 6.7.2. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. This attribute was +added in vSphere API 6.7.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Details.Type class defines the type of backup job. This enumeration +was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+MANUAL = Type(string='MANUAL')
+

Job type is Manual. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SCHEDULED = Type(string='SCHEDULED')
+

Job type is Scheduled. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+list(filter=None)
+

Returns detailed information about the current and historical backup +jobs. This method was added in vSphere API 6.7.

+
+
Parameters
+

filter (Details.FilterSpec or None) – Specification of matching backup jobs for which information should +be returned. +If None, the behavior is equivalent to Details.FilterSpec +with all attributes None which means all the backup jobs match the +filter.

+
+
Return type
+

dict of str and Details.Info

+
+
Returns
+

Map of backup job identifier to Info Structure. +The key in the return value dict will be an identifier for +the resource type: com.vmware.appliance.recovery.backup.job.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.backup.job_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.recovery.backup.system_name_client module

+
+
+class com.vmware.appliance.recovery.backup.system_name_client.Archive(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Archive class provides methods to get the backup information. This +class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(start_timestamp=None, end_timestamp=None, comment_substring=None, max_results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Archive.FilterSpec class contains attributes used to filter the +results when listing backup archives (see Archive.list()). If +multiple attributes are specified, only backup archives matching all of the +attributes match the filter. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • start_timestamp (datetime.datetime or None) – Backup must have been taken on or after this time to match the +filter. This attribute was added in vSphere API 6.7. +If None the filter will match oldest backups.

    • +

  • end_timestamp (datetime.datetime or None) – Backup must have been taken on or before this time to match the +filter. This attribute was added in vSphere API 6.7. +If None the filter will match most recent backups.

    • +

  • comment_substring (str or None) – Backup comment must contain this str to match the filter. +This attribute was added in vSphere API 6.7. +If None the filter will match backups with any comment.

    • +

  • max_results (long or None) – Limit result to a max count of most recent backups. This attribute +was added in vSphere API 6.7. +If None it defaults to 128.

    • +
+
+
+
+ +
+
+class Info(timestamp=None, location=None, parts=None, version=None, system_name=None, comment=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Archive.Info class represents backup archive information. This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • timestamp (datetime.datetime) – Time when this backup was completed. This attribute was added in +vSphere API 6.7.

    • +

  • location (str) – Backup location URL. This attribute was added in vSphere API 6.7.

    • +

  • parts (list of str) – List of parts included in the backup. This attribute was added in +vSphere API 6.7.

    • +

  • version (str) – The version of the appliance represented by the backup. This +attribute was added in vSphere API 6.7.

    • +

  • system_name (str) – The system name identifier of the appliance represented by the +backup. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name.

    • +

  • comment (str) – Custom comment added by the user for this backup. This attribute +was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Summary(archive=None, timestamp=None, version=None, comment=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Archive.Summary class contains commonly used information about a +backup archive. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • archive (str) – Backup archive identifier. This attribute was added in vSphere API +6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name.archive. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name.archive.

    • +

  • timestamp (datetime.datetime) – Time when this backup was started. This attribute was added in +vSphere API 6.7.

    • +

  • version (str) – The version of the appliance represented by the backup archive. +This attribute was added in vSphere API 6.7.

    • +

  • comment (str) – Custom comment added by the user for this backup. This attribute +was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+get(spec, system_name, archive)
+

Returns the information for backup corresponding to given backup +location and system name. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • spec (com.vmware.appliance.recovery.backup_client.LocationSpec) – LocationSpec Structure.

    • +

  • system_name (str) – System name identifier. +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name.

    • +

  • archive (str) – Archive identifier. +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name.archive.

    • +
+
+
Return type
+

Archive.Info

+
+
Returns
+

Info Structure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if backup does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+list(loc_spec, system_name, filter_spec)
+

Returns information about backup archives corresponding to given backup +location and system name, which match the Archive.FilterSpec. +This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • loc_spec (com.vmware.appliance.recovery.backup_client.LocationSpec) – LocationSpec Structure.

    • +

  • system_name (str) – System name identifier. +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.system_name.

    • +

  • filter_spec (Archive.FilterSpec) – Specification of matching backups for which information should be +returned.

    • +
+
+
Return type
+

list of Archive.Summary

+
+
Returns
+

Commonly used information about the backup archives.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if combination of loc_spec and system name does not refer to an +existing location on the backup server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.backup.system_name_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.recovery.html b/vsphere/8.0.2.0/com.vmware.appliance.recovery.html new file mode 100644 index 00000000..081ef255 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.recovery.html @@ -0,0 +1,1742 @@ + + + + + + + com.vmware.appliance.recovery package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance.recovery package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.recovery.backup_client module

+
+
+class com.vmware.appliance.recovery.backup_client.Job(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Job class provides methods to be performed on a backup job.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackupJobStatus(id=None, state=None, messages=None, progress=None, start_time=None, end_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Job.BackupJobStatus class represents the status of a backup/restore +job.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – TimeStamp based ID.

    • +

  • state (Job.BackupRestoreProcessState) – The state of the backup job.

    • +

  • messages (list of Job.LocalizableMessage) – List of messages.

    • +

  • progress (long) – Progress of the job in percentage.

    • +

  • start_time (datetime.datetime) – Time when the backup was started.

    • +

  • end_time (datetime.datetime or None) – Time when the backup was finished. +If None end time is None until backup is finished.

    • +
+
+
+
+ +
+
+class BackupRequest(parts=None, backup_password=None, location_type=None, location=None, location_user=None, location_password=None, comment=None, fast_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Job.BackupRequest class represents a requested backup piece.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • parts (list of str) – List of optional parts that will be included in the backup. Use the +Parts.list() method to get information about the supported +parts.

    • +

  • backup_password (str or None) – Password for a backup piece. The backupPassword must adhere to the +following password requirements: At least 8 characters, cannot be +more than 20 characters in length. At least 1 uppercase letter. At +least 1 lowercase letter. At least 1 numeric digit. At least 1 +special character (i.e. any character not in [0-9,a-z,A-Z]). Only +visible ASCII characters (for example, no space). +backupPassword If no password then the piece will not be encrypted

    • +

  • location_type (Job.LocationType) – Type of backup location.

    • +

  • location (str) – Path or URL of the backup location.

    • +

  • location_user (str or None) – Username for the given location. +If None authentication will not be used for the specified location.

    • +

  • location_password (str or None) – Password for the given location. +If None authentication will not be used for the specified location.

    • +

  • comment (str or None) – Custom comment provided by the user. +If None comment will be empty.

    • +

  • fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup +If None backup will proceed at slow rate

    • +
+
+
+
+ +
+
+class BackupRestoreProcessState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Job.BackupRestoreProcessState class defines the possible states of +a backup/restore process.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackupRestoreProcessState instance.

+
+
+
+
+FAILED = BackupRestoreProcessState(string='FAILED')
+

Backup/Restore job failed.

+
+ +
+
+INPROGRESS = BackupRestoreProcessState(string='INPROGRESS')
+

Backup/Restore job is in progress.

+
+ +
+
+NONE = BackupRestoreProcessState(string='NONE')
+

Backup/Restore job is not started.

+
+ +
+
+SUCCEEDED = BackupRestoreProcessState(string='SUCCEEDED')
+

Backup/Restore job completed successfully.

+
+ +
+ +
+
+class LocalizableMessage(id=None, default_message=None, args=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Job.LocalizableMessage class represents a localizable message.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Id in message bundle.

    • +

  • default_message (str) – Text in english.

    • +

  • args (list of str) – Nested data.

    • +
+
+
+
+ +
+
+class LocationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Job.LocationType class defines the type of destination location for +backup/restore. You specify the location type when you create a backup job. +See Job.BackupRequest.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LocationType instance.

+
+
+
+
+FTP = LocationType(string='FTP')
+

Destination is FTP server.

+
+ +
+
+FTPS = LocationType(string='FTPS')
+

Destination is FTPS server.

+
+ +
+
+HTTP = LocationType(string='HTTP')
+

Destination is HTTP server.

+
+ +
+
+HTTPS = LocationType(string='HTTPS')
+

Destination is HTTPS server.

+
+ +
+
+NFS = LocationType(string='NFS')
+

Destination is NFS server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+
+SCP = LocationType(string='SCP')
+

Destination is SSH server.

+
+ +
+
+SFTP = LocationType(string='SFTP')
+

Destination is SFTP server.

+
+ +
+
+SMB = LocationType(string='SMB')
+

Destination is SMB server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+ +
+
+class ReturnResult(status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Job.ReturnResult class contains the result information for the +cancel operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class ReturnStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Job.ReturnStatus class defines the return type for the cancel +operation. You specify the return status when you return the result of +cancel job. See Job.ReturnResult.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ReturnStatus instance.

+
+
+
+
+FAIL = ReturnStatus(string='FAIL')
+

Cancel operation failed.

+
+ +
+
+OK = ReturnStatus(string='OK')
+

Cancel operation succeeded.

+
+ +
+
+WARNING = ReturnStatus(string='WARNING')
+

Cancel operation passed with warnings.

+
+ +
+ +
+
+cancel(id)
+

Cancel the backup job.

+
+
Parameters
+

id (str) – ID (ID of job) +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.job.

+
+
Return type
+

Job.ReturnResult

+
+
Returns
+

BackupJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if backup associated with id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+create(piece)
+

Initiate backup.

+
+
Parameters
+

piece (Job.BackupRequest) – BackupRequest Structure

+
+
Return type
+

Job.BackupJobStatus

+
+
Returns
+

BackupJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.FeatureInUse +A backup or restore is already in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+get(id)
+

See backup job progress/result.

+
+
Parameters
+

id (str) – ID (ID of job) +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.job.

+
+
Return type
+

Job.BackupJobStatus

+
+
Returns
+

BackupJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if backup associated with id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+list()
+

Get list of backup jobs

+
+
Return type
+

list of str

+
+
Returns
+

list of BackupJob IDs +The return value will contain identifiers for the resource type: +com.vmware.appliance.recovery.backup.job.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.backup_client.LocationSpec(location=None, location_user=None, location_password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocationSpec class has fields to represent a location on the backup +server. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • location (str) – Backup location URL. This attribute was added in vSphere API 6.7.

    • +

  • location_user (str or None) – Username for the given location. This attribute was added in +vSphere API 6.7. +If None authentication will not be used.

    • +

  • location_password (str or None) – Password for the given location. This attribute was added in +vSphere API 6.7. +If None authentication will not be used.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.recovery.backup_client.Parts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Parts class provides methods Provides list of parts optional for the +backup

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class LocalizableMessage(id=None, default_message=None, args=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parts.LocalizableMessage class Structure representing message

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – id in message bundle

    • +

  • default_message (str) – text in english

    • +

  • args (list of str) – nested data

    • +
+
+
+
+ +
+
+class Part(id=None, name=None, description=None, selected_by_default=None, optional=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Parts.Part class Structure representing backup restore part

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – part ID +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.parts. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.appliance.recovery.backup.parts.

    • +

  • name (Parts.LocalizableMessage) – part name id in message bundle

    • +

  • description (Parts.LocalizableMessage) – part description id in message bundle

    • +

  • selected_by_default (bool) – Is this part selected by default in the user interface.

    • +

  • optional (bool) – Is this part optional.

    • +
+
+
+
+ +
+
+get(id)
+

Gets the size (in MB) of the part.

+
+
Parameters
+

id (str) – Identifier of the part. +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.parts.

+
+
Return type
+

long

+
+
Returns
+

long Size of the part in megabytes.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+list()
+

Gets a list of the backup parts.

+
+
Return type
+

list of Parts.Part

+
+
Returns
+

Information about each of the backup parts.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.backup_client.Schedules(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Schedules class provides methods to be performed to manage backup +schedules. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(parts=None, backup_password=None, location=None, location_user=None, location_password=None, enable=None, recurrence_info=None, retention_info=None, fast_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Schedules.CreateSpec class contains fields to be specified for +creating a new schedule. The structure includes parts, location +information, encryption password and enable flag. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • parts (list of str or None) – List of optional parts to be backed up. Use the Parts.list() +method to get information about the supported parts. This attribute +was added in vSphere API 6.7. +If None all the optional parts will not be backed up.

    • +

  • backup_password (str or None) – Password for a backup piece. The backupPassword must adhere to the +following password requirements: At least 8 characters, cannot be +more than 20 characters in length. At least 1 uppercase letter. At +least 1 lowercase letter. At least 1 numeric digit. At least 1 +special character (i.e. any character not in [0-9,a-z,A-Z]). Only +visible ASCII characters (for example, no space). This attribute +was added in vSphere API 6.7. +If None the backup piece will not be encrypted.

    • +

  • location (str) – URL of the backup location. This attribute was added in vSphere API +6.7.

    • +

  • location_user (str or None) – Username for the given location. This attribute was added in +vSphere API 6.7. +If None authentication will not be used for the specified location.

    • +

  • location_password (str or None) – Password for the given location. This attribute was added in +vSphere API 6.7. +If None authentication will not be used for the specified location.

    • +

  • enable (bool or None) – Enable or disable a schedule. This attribute was added in vSphere +API 6.7. +If None the schedule will be enabled.

    • +

  • recurrence_info (Schedules.RecurrenceInfo or None) – Recurrence information for the schedule. This attribute was added +in vSphere API 6.7. +If None backup job will not be scheduled. See +Schedules.RecurrenceInfo

    • +

  • retention_info (Schedules.RetentionInfo or None) – Retention information for the schedule. This attribute was added in +vSphere API 6.7. +If None all the completed backup jobs will be retained forever. See +Schedules.RetentionInfo

    • +

  • fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. This attribute was +added in vSphere API 6.7. +If None backup will proceed at slow rate

    • +
+
+
+
+ +
+
+class DayOfWeek(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Schedules.DayOfWeek class defines the set of days when backup can +be scheduled. The days can be specified as a list of individual days. You +specify the days when you set the recurrence for a schedule. See +Schedules.RecurrenceInfo.days. This enumeration was added in +vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DayOfWeek instance.

+
+
+
+
+FRIDAY = DayOfWeek(string='FRIDAY')
+

Friday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+MONDAY = DayOfWeek(string='MONDAY')
+

Monday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SATURDAY = DayOfWeek(string='SATURDAY')
+

Saturday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SUNDAY = DayOfWeek(string='SUNDAY')
+

Sunday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+THURSDAY = DayOfWeek(string='THURSDAY')
+

Thursday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+TUESDAY = DayOfWeek(string='TUESDAY')
+

Tuesday. This class attribute was added in vSphere API 6.7.

+
+ +
+
+WEDNESDAY = DayOfWeek(string='WEDNESDAY')
+

Wednesday. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class Info(parts=None, location=None, location_user=None, enable=None, recurrence_info=None, retention_info=None, fast_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Schedules.Info class contains information about an existing +schedule. The structure includes Schedule ID, parts, location information, +encryption password, enable flag, recurrence and retention information. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • parts (list of str) – List of optional parts that will be included in backups based on +this schedule details. Use the Parts.list() method to get +information about the supported parts. This attribute was added in +vSphere API 6.7.

    • +

  • location (str) – URL of the backup location. This attribute was added in vSphere API +6.7.

    • +

  • location_user (str or None) – Username for the given location. This attribute was added in +vSphere API 6.7. +If None location user will not be used.

    • +

  • enable (bool) – Enable or disable a schedule, by default when created a schedule +will be enabled. This attribute was added in vSphere API 6.7.

    • +

  • recurrence_info (Schedules.RecurrenceInfo or None) – Recurrence information for the schedule. This attribute was added +in vSphere API 6.7. +If None backup job is not scheduled. See +Schedules.RecurrenceInfo

    • +

  • retention_info (Schedules.RetentionInfo or None) – Retention information for the schedule. This attribute was added in +vSphere API 6.7. +If None all the completed backup jobs are retained forever. See +Schedules.RetentionInfo

    • +

  • fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. This attribute was +added in vSphere API 6.7. +If None backup will proceed at slow rate

    • +
+
+
+
+ +
+
+class RecurrenceInfo(minute=None, hour=None, days=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Schedules.RecurrenceInfo class contains the recurrence information +associated with a schedule. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • minute (long) – Minute when backup should run. This attribute was added in vSphere +API 6.7.

    • +

  • hour (long) – Hour when backup should run. The hour should be specified in +24-hour clock format. This attribute was added in vSphere API 6.7.

    • +

  • days (list of Schedules.DayOfWeek or None) – Day of week when the backup should be run. Days can be specified as +list of days. This attribute was added in vSphere API 6.7. +If None the backup will be run everyday.

    • +
+
+
+
+ +
+
+class RetentionInfo(max_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Schedules.RetentionInfo class contains retention information +associated with a schedule. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

max_count (long) – Number of backups which should be retained. If retention is not +set, all the backups will be retained forever. This attribute was +added in vSphere API 6.7.

+
+
+
+ +
+
+class UpdateSpec(parts=None, backup_password=None, location=None, location_user=None, location_password=None, enable=None, recurrence_info=None, retention_info=None, fast_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Schedules.UpdateSpec class contains the fields of the existing +schedule which can be updated. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • parts (list of str or None) – List of optional parts. Use the Parts.list() method to get +information about the supported parts. This attribute was added in +vSphere API 6.7. +If None the value will not be changed.

    • +

  • backup_password (str or None) – Password for a backup piece. The backupPassword must adhere to the +following password requirements: At least 8 characters, cannot be +more than 20 characters in length. At least 1 uppercase letter. At +least 1 lowercase letter. At least 1 numeric digit. At least 1 +special character (i.e. any character not in [0-9,a-z,A-Z]). Only +visible ASCII characters (for example, no space). This attribute +was added in vSphere API 6.7. +If None the value will not be changed.

    • +

  • location (str or None) – URL of the backup location. This attribute was added in vSphere API +6.7. +If None the value will not be changed.

    • +

  • location_user (str or None) – Username for the given location. This attribute was added in +vSphere API 6.7. +If None the value will not be changed.

    • +

  • location_password (str or None) – Password for the given location. This attribute was added in +vSphere API 6.7. +If None the value will not be changed.

    • +

  • enable (bool or None) – Enable or disable a schedule. This attribute was added in vSphere +API 6.7. +If None the value will not be changed.

    • +

  • recurrence_info (Schedules.RecurrenceInfo or None) – Recurrence information for the schedule. This attribute was added +in vSphere API 6.7. +If None the infomration will not be changed. See +Schedules.RecurrenceInfo

    • +

  • retention_info (Schedules.RetentionInfo or None) – Retention information for the schedule. This attribute was added in +vSphere API 6.7. +If None the information will not be changed. See +Schedules.RetentionInfo

    • +

  • fast_backup (bool or None) – Option to enable Postgres DB/ VCDB fast backup. This attribute was +added in vSphere API 6.7. +If None backup will proceed at slow rate

    • +
+
+
+
+ +
+
+create(schedule, spec)
+

Creates a schedule. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • schedule (str) – Identifier of the schedule +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.schedule.

    • +

  • spec (Schedules.CreateSpec) – CreateSpec Structure

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if provided with invalid schedule specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the schedule with the given id already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+delete(schedule)
+

Deletes an existing schedule. This method was added in vSphere API 6.7.

+
+
Parameters
+

schedule (str) – Identifier of the schedule +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.schedule.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if schedule associated with id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+get(schedule)
+

Returns an existing schedule information based on id. This method was +added in vSphere API 6.7.

+
+
Parameters
+

schedule (str) – Identifier of the schedule +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.schedule.

+
+
Return type
+

Schedules.Info

+
+
Returns
+

Info Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if schedule associated with id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+list()
+

Returns a list of existing schedules with details. This method was +added in vSphere API 6.7.

+
+
Return type
+

dict of str and Schedules.Info

+
+
Returns
+

Map of schedule id to Info Structure +The key in the return value dict will be an identifier for +the resource type: +com.vmware.appliance.recovery.backup.schedule.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+run(schedule, comment=None)
+

Initiate backup with the specified schedule. This method was added in +vSphere API 6.7.

+
+
Parameters
+
    +

  • schedule (str) – Identifier of the schedule +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.schedule.

    • +

  • comment (str or None) – field that specifies the description for the backup. +If None the backup will have an empty comment.

    • +
+
+
Return type
+

Job.BackupJobStatus

+
+
Returns
+

BackupJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.FeatureInUse +if a backup or restore is already in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if schedule associated with id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+update(schedule, spec)
+

Updates a schedule. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • schedule (str) – Identifier of the schedule +The parameter must be an identifier for the resource type: +com.vmware.appliance.recovery.backup.schedule.

    • +

  • spec (Schedules.UpdateSpec) – UpdateSpec Structure

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if provided with invalid schedule specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if schedule associated with id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.backup_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.recovery.backup_client.SystemName(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SystemName class provides methods to enumerate system names of +appliance backups. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+list(loc_spec)
+

Returns a list of system names for which backup archives exist under +loc_spec. This method was added in vSphere API 6.7.

+
+
Parameters
+

loc_spec (LocationSpec) – LocationSpec Structure

+
+
Return type
+

list of str

+
+
Returns
+

list of system names +The return value will contain identifiers for the resource type: +com.vmware.appliance.recovery.backup.system_name.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if loc_spec doesn’t refer to an existing location on the backup +server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+

com.vmware.appliance.recovery.reconciliation_client module

+
+
+class com.vmware.appliance.recovery.reconciliation_client.Job(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Job class provides methods to create and get the status of +reconciliation job. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(sso_admin_user_name=None, sso_admin_user_password=None, ignore_warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Job.CreateSpec class has the fields to request the start of +reconciliation job. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • sso_admin_user_name (str or None) – Administrators username for SSO. This attribute was added in +vSphere API 6.7. +If None SSO authentication will not be used. If the vCenter Server +is a management node or an embedded node, authentication is +required.

    • +

  • sso_admin_user_password (str or None) – Password for SSO admin user. This attribute was added in vSphere +API 6.7. +If None SSO authentication will not be used. If the vCenter Server +is a management node or an embedded node, authentication is +required.

    • +

  • ignore_warnings (bool or None) – Flag indicating whether warnings should be ignored during +reconciliation. This attribute was added in vSphere API 6.7. +If None, validation warnings will fail the reconciliation +operation.

    • +
+
+
+
+ +
+
+class Info(description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, messages=None, progress=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Job.Info class represents the reconciliation job information. It +contains information related to current Status, any associated messages and +progress as percentage. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task. This +attribute was added in vSphere API 6.7.

    • +

  • service (str) – Name of the service containing the operation. This attribute was +added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.recovery.reconciliation.job. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.appliance.recovery.reconciliation.job.

    • +

  • operation (str) – Name of the operation associated with the task. This attribute was +added in vSphere API 6.7.

    • +

  • parent (str or None) – Parent of the current task. This attribute was added in vSphere API +6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.recovery.reconciliation.job. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.appliance.recovery.reconciliation.job. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target resource the operation modifies. This +attribute was added in vSphere API 6.7. +This attribute will be None if the task has multiple targets or no +target.

    • +

  • status (Job.Status) – Status of the operation associated with the task. This attribute +was added in vSphere API 6.7.

    • +

  • cancelable (bool or None) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses. This attribute was +added in vSphere API 6.7. +If None, the operation cannot be canceled.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. This +attribute was added in vSphere API 6.7. +If None the description of why the operation failed will be +included in the result of the operation (see Info#result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of status is one of Job.Status.RUNNING, +Job.Status.SUCCEEDED, or Job.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of status is one of Job.Status.SUCCEEDED or +Job.Status.FAILED.

    • +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) – A list of localized messages. This attribute was added in vSphere +API 6.7.

    • +

  • progress (long) – The progress of the job as a percentage. This attribute was added +in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Job.Status class defines the status values that can be reported for +an operation. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+FAILED = Status(string='FAILED')
+

The operation failed. This class attribute was added in vSphere API 6.7.

+
+ +
+
+NONE = Status(string='NONE')
+

The operation is not running. This class attribute was added in vSphere API +6.7.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The operation is in progress. This class attribute was added in vSphere API +6.7.

+
+ +
+
+SUCCEEDED = Status(string='SUCCEEDED')
+

The operation completed successfully. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+create(spec)
+

Initiate reconciliation. This method was added in vSphere API 6.7.

+
+
Parameters
+

spec (Job.CreateSpec) – CreateSpec Structure

+
+
Return type
+

Job.Info

+
+
Returns
+

Info Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.FeatureInUse +A backup or restore is already in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +Reconciliation is allowed only after restore has finished +successfully.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+get()
+

Get reconciliation job progress/result. This method was added in +vSphere API 6.7.

+
+
Return type
+

Job.Info

+
+
Returns
+

Info Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no running reconciliation job.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.reconciliation_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.recovery.restore_client module

+
+
+class com.vmware.appliance.recovery.restore_client.Job(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Job class provides methods Performs restore operations

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackupRestoreProcessState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Job.BackupRestoreProcessState class Defines state of backup/restore +process

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackupRestoreProcessState instance.

+
+
+
+
+FAILED = BackupRestoreProcessState(string='FAILED')
+

Failed

+
+ +
+
+INPROGRESS = BackupRestoreProcessState(string='INPROGRESS')
+

In progress

+
+ +
+
+NONE = BackupRestoreProcessState(string='NONE')
+

Not started

+
+ +
+
+SUCCEEDED = BackupRestoreProcessState(string='SUCCEEDED')
+

Completed successfully

+
+ +
+ +
+
+class LocalizableMessage(id=None, default_message=None, args=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Job.LocalizableMessage class Structure representing message

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – id in message bundle

    • +

  • default_message (str) – text in english

    • +

  • args (list of str) – nested data

    • +
+
+
+
+ +
+
+class LocationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Job.LocationType class Defines type of all locations for backup/restore

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LocationType instance.

+
+
+
+
+FTP = LocationType(string='FTP')
+

Destination is FTP server

+
+ +
+
+FTPS = LocationType(string='FTPS')
+

Destination is FTPS server

+
+ +
+
+HTTP = LocationType(string='HTTP')
+

Destination is HTTP server

+
+ +
+
+HTTPS = LocationType(string='HTTPS')
+

Destination is HTTPS server

+
+ +
+
+NFS = LocationType(string='NFS')
+

Destination is NFS server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+
+SCP = LocationType(string='SCP')
+

Destination is SSH server

+
+ +
+
+SFTP = LocationType(string='SFTP')
+

Destination is SFTP server

+
+ +
+
+SMB = LocationType(string='SMB')
+

Destination is SMB server. This class attribute was added in vSphere API +6.7.2.

+
+ +
+ +
+
+class RestoreJobStatus(state=None, messages=None, progress=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Job.RestoreJobStatus class Structure representing backup restore status

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class RestoreRequest(backup_password=None, location_type=None, location=None, location_user=None, location_password=None, sso_admin_user_name=None, sso_admin_user_password=None, ignore_warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Job.RestoreRequest class Structure representing requested restore piece

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backup_password (str or None) – a password for a backup piece +backupPassword If no password then the piece will not be decrypted

    • +

  • location_type (Job.LocationType) – a type of location

    • +

  • location (str) – path or url

    • +

  • location_user (str or None) – username for location +locationUser User name for this location if login is required.

    • +

  • location_password (str or None) – password for location +locationPassword Password for the specified user if login is +required at this location.

    • +

  • sso_admin_user_name (str or None) – Administrators Username for SSO. This attribute was added in +vSphere API 6.7. +If None SSO authentication will not be used. If the vCenter Server +is a management node or an embedded node, authentication is +required.

    • +

  • sso_admin_user_password (str or None) – The password for SSO admin user. This attribute was added in +vSphere API 6.7. +If None SSO authentication will not be used. If the vCenter Server +is a management node or an embedded node, authentication is +required.

    • +

  • ignore_warnings (bool or None) – The flag to ignore warnings during restore. This attribute was +added in vSphere API 6.7. +If None, validation warnings will fail the restore operation

    • +
+
+
+
+ +
+
+class ReturnResult(status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Job.ReturnResult class Structure representing precheck result

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class ReturnStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Job.ReturnStatus class Defines the state of precheck

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ReturnStatus instance.

+
+
+
+
+FAIL = ReturnStatus(string='FAIL')
+

Check failed

+
+ +
+
+OK = ReturnStatus(string='OK')
+

Check passed

+
+ +
+
+WARNING = ReturnStatus(string='WARNING')
+

Passed with warnings

+
+ +
+ +
+
+cancel()
+

Cancel the restore job

+
+
Return type
+

Job.ReturnResult

+
+
Returns
+

RestoreJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+create(piece)
+

Initiate restore.

+
+
Parameters
+

piece (Job.RestoreRequest) – RestoreRequest Structure

+
+
Return type
+

Job.RestoreJobStatus

+
+
Returns
+

RestoreJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.FeatureInUse +A backup or restore is already in progress

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +Restore is allowed only after deployment and before firstboot

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+get()
+

See restore job progress/result.

+
+
Return type
+

Job.RestoreJobStatus

+
+
Returns
+

RestoreJobStatus Structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.recovery.restore_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.system.html b/vsphere/8.0.2.0/com.vmware.appliance.system.html new file mode 100644 index 00000000..d6f2fd96 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.system.html @@ -0,0 +1,298 @@ + + + + + + + com.vmware.appliance.system package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance.system package

+
+

Submodules

+
+
+

com.vmware.appliance.system.security_client module

+
+
+class com.vmware.appliance.system.security_client.GlobalFips(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The GlobalFips class provides methods to enable/disable appliance FIPS +mode. This class was added in vSphere API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool) – FIPS setting state. This attribute was added in vSphere API +7.0.1.0.

+
+
+
+ +
+
+class UpdateSpec(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool or None) – FIPS setting state. This attribute was added in vSphere API +7.0.1.0. +If None, the value is unchanged.

+
+
+
+ +
+
+get()
+

Get current appliance FIPS settings. This method was added in vSphere +API 7.0.1.0.

+
+
Return type
+

GlobalFips.Info

+
+
Returns
+

Current FIPS settings state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+update(spec)
+

Enable/Disable Global FIPS mode for the appliance.

+

Caution: Changing the value of this setting will reboot the +Appliance.. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+

spec (GlobalFips.UpdateSpec) –

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance.system.security_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.system.time_client module

+
+
+class com.vmware.appliance.system.time_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.system.time_client.Timezone(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Timezone class provides methods to get and set the appliance +timezone. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Get time zone. This method was added in vSphere API 6.7.

+
+
Return type
+

str

+
+
Returns
+

Time zone name.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if timezone cannot be read.

+
+
+
+ +
+
+set(name)
+

Set time zone. This method was added in vSphere API 6.7.

+
+
Parameters
+

name (str) – Time zone name.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.html new file mode 100644 index 00000000..76ad6877 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.html @@ -0,0 +1,190 @@ + + + + + + + com.vmware.appliance.vcenter package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance.vcenter package

+
+

Subpackages

+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.html new file mode 100644 index 00000000..22b4c166 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.html @@ -0,0 +1,1996 @@ + + + + + + + com.vmware.appliance.vcenter.settings package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.appliance.vcenter.settings package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.vcenter.settings.v1_client module

+

The com.vmware.appliance.vcenter.settings.v1_client module provides classes +to manage the ConfigManagement.

+
+
+class com.vmware.appliance.vcenter.settings.v1_client.ApplyImpact(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ApplyImpact class contains information about the impact of applying +the target state. Warning: This enumeration is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplyImpact instance.

+
+
+
+
+NO_IMPACT = ApplyImpact(string='NO_IMPACT')
+

Appliance has no impact. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+REBOOT_REQUIRED = ApplyImpact(string='REBOOT_REQUIRED')
+

Appliance requires reboot to reach this target state. Warning: This +class attribute is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+RESTART_SERVICE = ApplyImpact(string='RESTART_SERVICE')
+

To reach the target state appliance requires services to restart. +Warning: This class attribute is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.CheckResult(impact=None, start_time=None, end_time=None, profile=None, version=None, valid=None, invalid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckResult class contains attributes that describe the precheck +results of an appliance. method. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (Impact) – Overall Impact. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • start_time (datetime.datetime) – Time when the method started. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • end_time (datetime.datetime or None) – Time when the method completed. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +If None, the endTime will be empty.

    • +

  • profile (str) – Identifier of the profile on which the prechek is run to generate +this result. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile.

    • +

  • version (str) – The version of the profile. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • valid (set of str) – Identifiers of the valid components. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • invalid (set of str) – Identifiers of the Invalid components. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.ComplianceResult(diff_results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComplianceResult class defines the information about scan results. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

diff_results (dict of str and DiffResult) – Map of property value differences between current software state +and working profile. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.Config(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Config class provides methods to manage desired configuration +specification of vCenter.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyDesiredStateSpec(desired_state=None, apply_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.ApplyDesiredStateSpec class contains attributes that +describe desired state spec apply specification for vCenter. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • desired_state (DesiredState) – Defines the desired state. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • apply_spec (Config.ApplySpec) – applySpec to include a message with the apply. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class ApplyResult(status=None, start_time=None, end_time=None, notifications=None, profile=None, version=None, success=None, failed=None, skipped=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.ApplyResult class contains attributes that describe the +result of an apply operation. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Config.ApplyStatus) – Specifies the aggregated status. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • start_time (datetime.datetime) – Time when the method started. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • end_time (datetime.datetime or None) – Time when the method completed. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +If None, the endTime will be empty.

    • +

  • notifications (Notifications) – Notifications providing additional information about the status of +the method. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • profile (str) – The identifier of the commit used to fetch the configuration state +to be applied to all components within the appliance. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile.

    • +

  • version (str) – The version of the profile. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version.

    • +

  • success (set of str) – Set of successfully applied components. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • failed (set of str) – Set of failed components. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • skipped (set of str) – Set of skipped components. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +
+
+
+
+ +
+
+class ApplySpec(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.ApplySpec class contains attributes that describe desired +profile apply specification for vCenter. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (str) – Message to include with the apply. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
+
+ +
+
+class ApplyStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Config.ApplyStatus class contains the possible different status +codes that can be returned while trying to apply the configuration +specification to the vcenter. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplyStatus instance.

+
+
+
+
+ERROR = ApplyStatus(string='ERROR')
+

The method encountered an error. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+SKIPPED = ApplyStatus(string='SKIPPED')
+

The method was skipped. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+SUCCESS = ApplyStatus(string='SUCCESS')
+

The method completed successfully. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+TIMED_OUT = ApplyStatus(string='TIMED_OUT')
+

The method timed out. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+ +
+
+class CheckDesiredStateSpec(desired_state=None, check_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.CheckDesiredStateSpec class contains attributes that +describe desired state spec check specification for vCenter. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • desired_state (DesiredState) – Defines the desired state. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • check_spec (Config.CheckSpec) – checkSpec to include a message with the apply. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class CheckSpec(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.CheckSpec class contains attributes that describe desired +profile check specification for vCenter. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (str) – Message to include with the check. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
+
+ +
+
+class CreateSpec(name=None, description=None, desired_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.CreateSpec class contains the specification required to +create a profile in vCenter. the spec contains attributes that describe +information about the profile. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the profile. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • description (str or None) – Description of the profile. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +If None, the description will be empty.

    • +

  • desired_state (DesiredState) – Defines the desired state. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+class Info(profile=None, version=None, name=None, creation_time=None, owner=None, description=None, desired_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.Info class represents information about the config profile. +the spec contains attributes that describe information about the profile. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • profile (str) – The identifier of the profile. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile.

    • +

  • version (str) – Version of the profile. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version.

    • +

  • name (str) – Name of the profile. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • creation_time (datetime.datetime) – Creation time of the profile. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • owner (str) – Owner of the profile, the one who created. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • description (str or None) – Custom description provided by the user. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +If None description will be empty.

    • +

  • desired_state (DesiredState) – The desired state. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+class ScanSpec(message=None, desired_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Config.ScanSpec class contains the specification required for +compliance check against the vCenter current config state. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • message (str or None) – Message for the scan. This may act as an identification for the +scan operation. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +If None, the message will be empty.

    • +

  • desired_state (DesiredState) – Defines the desired state. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+apply_desired_state_task(spec)
+

Apply the specified DesiredState spec to the vCenter. The result of +this operation can be queried by calling the cis/tasks/{task-id} where +the task-id is the response of this operation. Warning: This method +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

spec (Config.ApplyDesiredStateSpec) – ApplyDesiredStateSpec spec to be validated and applied.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If validation of the desired-state spec fails. The value of the +data attribute of com.vmware.vapi.std.errors_client.Error +will be a class that contains all the attributes defined in +Config.ApplyResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+check_desired_state_task(spec)
+

Validate (Check) the specified DesiredState spec containing +configurations, and verify if it can be applied to the vCenter. The +result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation. Warning: This method is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview +APIs might only be applicable to specific environments.

+
+
Parameters
+

spec (Config.CheckDesiredStateSpec) – CheckDesiredStateSpec spec to be validated.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+create(spec)
+

Creates a Profile. Warning: This method is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

+
+
Parameters
+

spec (Config.CreateSpec) – Specification of the profile to be created.

+
+
Return type
+

str

+
+
Returns
+

ID of newly-created profile. +The return value will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a profile with the specified name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+delete()
+

Deletes a profile. Warning: This method is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if any other operation running on the same profile.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the profile is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate service to complete the +request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+get()
+

Returns information about a profile. Warning: This method is +available as Technology Preview. These are early access APIs provided +to test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Return type
+

Config.Info

+
+
Returns
+

Information about the specified profile.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If given version is different than the latest one.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no profile or version associated with profile or +version in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+scan_desired_state_task(spec)
+

Scans all the components in the desired state against the applied +profile. result of this operation can be queried by calling the api +cis/tasks/{task-id} where the task-id is the response of this +operation. Warning: This method is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview +APIs might only be applicable to specific environments.

+
+
Parameters
+

spec (Config.ScanSpec) –

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+scan_task(version)
+

Scans all the components in the profiles against the applied profile. +result of this operation can be queried by calling the api +cis/tasks/{task-id} where the task-id is the response of this +operation. Warning: This method is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview +APIs might only be applicable to specific environments.

+
+
Parameters
+

version (str) – version of the profile. +The parameter must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no profile associated with profile in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.ConfigCurrent(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ConfigCurrent class provides methods to get the current state of +the vCenter. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class InvokerType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ConfigCurrent.InvokerType class contains the possible invoker type, +to be passed on to plugins to understand the consumer. Warning: This +enumeration is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the InvokerType instance.

+
+
+
+
+INTERNAL = InvokerType(string='INTERNAL')
+

Invoker requires internal config details in DS spec. Warning: This +class attribute is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+USER = InvokerType(string='USER')
+

Invoker is an end user. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+ +
+
+get(invoker_type=None, components=None)
+

Returns the current state of the vCenter. Warning: This method is +available as Technology Preview. These are early access APIs provided +to test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+
+
+
Return type
+

DesiredState

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.DesiredState(appliance=None, authmgmt=None, inventory=None, vsphereuiconfiguration=None, invtauthmgmt=None, managementcluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DesiredState class defines the configuration about different +components in vCenter. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • appliance (com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement or None) – Appliance Management component desired spec. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • authmgmt (com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement or None) – Authentication Management component desired spec. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • inventory (com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement or None) – Inventory Configurations. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • vsphereuiconfiguration (com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client.VsphereUIConfiguration or None) – Clientcapabilities Configurations. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • invtauthmgmt (com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.InventoryAuthorization or None) – Inventory Authorization. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • managementcluster (com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementCluster or None) – Management Cluster Configurations. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.DiffResult(current_value=None, desired_value=None, category=None, path=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DiffResult class defines the information about the feature +configuration. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • current_value (DataValue) – Current property value. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • desired_value (DataValue) – Desired property value. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • category (str) – Category of component configuration. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • path (str) – Path of the component configuration. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • description (str) – Description of the component configuration. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.Impact(apply_impact=None, vcenter_services=None, system_services=None, message=None, status=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Impact class contains attributes that describe the impact during +apply. method. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • apply_impact (ApplyImpact) – Impact to the vCenter if the profile is applied. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • vcenter_services (set of str or None) – List of the vCenter services to be restarted. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +If None there no impact on system.

    • +

  • system_services (set of str or None) – List of the System services to be restarted. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +If None there no impact on system.

    • +

  • message (list of com.vmware.vapi.std_client.LocalizableMessage) – Description of the impact. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • status (StatusType) – Validation status of the appliance. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • notifications (Notifications) – Notifications returned by the validation operation. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.Notification(notification=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class contains attributes to describe any +info/warning/error messages that Tasks can raise. Warning: This class +is available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • notification (str) – The notification Identifier. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.notification. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.notification.

    • +

  • time (datetime.datetime or None) – The time the notification was raised. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +Only set if the time information is available.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +Only set for warnings and errors.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the task. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +Only set if an info was reported by the task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +Only set if an warning was reported by the task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +Only set if an error was reported by the task.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.ScanResult(status=None, notifications=None, start_time=None, end_time=None, profile=None, version=None, compliant=None, non_compliant=None, unavailable=None, compliance_result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ScanResult class contains attributes to describe the scan result of +a appliance. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ScanResult.ComplianceStatus) – Aggregrated compliance state of the appliance. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • notifications (Notifications) – Notifications returned by the scan operation. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • start_time (datetime.datetime) – Time when the method started. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • end_time (datetime.datetime or None) – Time when the method completed. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +If None, the endTime will be empty.

    • +

  • profile (str) – Identifier of the apply on which the scan is run to generate this +result. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.profile.

    • +

  • version (str) – The version of the profile. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.version.

    • +

  • compliant (set of str) – Identifiers of compliant components. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • non_compliant (set of str) – Identifiers of non-compliant components. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • unavailable (set of str) – Identifiers of unavailable components. There will not be compliance +details for these components. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +

  • compliance_result (dict of str and ComplianceResult) – Mapping of component identifier to the compliance result. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: +com.vmware.appliance.vcenter.settings.v1.config.component. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: +com.vmware.appliance.vcenter.settings.v1.config.component.

    • +
+
+
+
+
+class ComplianceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ScanResult.ComplianceStatus class contains the possible different +status of compliance with respect to target version. Warning: This +enumeration is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceStatus instance.

+
+
+
+
+COMPLIANT = ComplianceStatus(string='COMPLIANT')
+

Target configuration is same as the current configuration?. Warning: +This class attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+ +
+
+NON_COMPLIANT = ComplianceStatus(string='NON_COMPLIANT')
+

Target configuration is not same as the current configuration. Warning: +This class attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+ +
+
+UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')
+

Scan check failed due to unknown error or check hasn’t happened yet and the +results are not available. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.StatusType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The StatusType class defines possible values of profile status. +Warning: This enumeration is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StatusType instance.

+
+
+
+
+INVALID = StatusType(string='INVALID')
+

Profile Configuration is invalid. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+VALID = StatusType(string='VALID')
+

Profile configuration is valid. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1_client.TaskInfo(progress=None, notifications=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TaskInfo class contains information about a task. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – Progress of the operation. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • notifications (Notifications or None) – Notifications to the user. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +Only set if the notifications were reported by this +particular task.

    • +

  • result (DataValue or None) – Task result. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +This attribute will be None if the task has no result.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.html new file mode 100644 index 00000000..af4057ec --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.html @@ -0,0 +1,3078 @@ + + + + + + + com.vmware.appliance.vcenter.settings.v1.config.components package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.appliance.vcenter.settings.v1.config.components package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.AccessSettings(ssh=None, dcui=None, console_cli=None, shell=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This AccessSettings class to set/get access settings.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ssh (Ssh or None) – Get/Set enabled state of SSH-based controlled CLI. Ssh class +provides methods

    • +

  • dcui (Dcui or None) – Get/Set enabled of Direct Console User Interface (DCUI TTY2). +Dcui class provides methods

    • +

  • console_cli (Consolecli or None) – Get/Set enabled state of the console-based controlled CLI. +Consolecli class provides methods

    • +

  • shell (Shell or None) – Get/Set enabled state of BASH. Shell class provides methods

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address(address=None, origin=None, prefix=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Address class provides the structure used to name an IPv6 address.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str or None) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a. +If set, the address was never set.

    • +

  • origin (Address.Origin or None) – The Origin of the IPv6 address. For more information, see RFC 4293. +If set, the origin was never set.

    • +

  • prefix (long or None) – The IPv6 CIDR prefix, for example, 64. +If set, the prefix was never set.

    • +

  • status (Address.Status or None) – The Status of the IPv6 address. For more information, see RFC 4293. +If set, the status was never set.

    • +
+
+
+
+
+class Origin(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Address.Origin class defines IPv6 address origin values.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Origin instance.

+
+
+
+
+DHCP = Origin(string='DHCP')
+

The IPv6 address is assigned by a DHCP server. See RFC 4293.

+
+ +
+
+LINKLAYER = Origin(string='LINKLAYER')
+

The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration +(SLAAC). See RFC 4293.

+
+ +
+
+MANUAL = Origin(string='MANUAL')
+

The IPv6 address was manually configured to a specified address, for +example, by user configuration. See RFC 4293.

+
+ +
+
+OTHER = Origin(string='OTHER')
+

The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC, +or random. See RFC 4293.

+
+ +
+
+RANDOM = Origin(string='RANDOM')
+

The IPv6 address is assigned randomly by the system. See RFC 4293.

+
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Address.Status class defines IPv6 address status values. See RFC +4293.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+DEPRECATED = Status(string='DEPRECATED')
+

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.

+
+ +
+
+DUPLICATE = Status(string='DUPLICATE')
+

The IPv6 address is not unique on the link and cannot be used.

+
+ +
+
+INACCESSIBLE = Status(string='INACCESSIBLE')
+

The IPv6 address is inaccessible because the interface to which this +address is assigned is not operational.

+
+ +
+
+INVALID = Status(string='INVALID')
+

The IPv6 address is not a valid address. It should not appear as the +destination or source address of a packet.

+
+ +
+
+OPTIMISTIC = Status(string='OPTIMISTIC')
+

The IPv6 address is available for use, subject to restrictions, while its +uniqueness on a link is being verified.

+
+ +
+
+PREFERRED = Status(string='PREFERRED')
+

This is a valid IPv6 address that can appear as the destination or source +address of a packet.

+
+ +
+
+TENTATIVE = Status(string='TENTATIVE')
+

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.

+
+ +
+
+UNKNOWN = Status(string='UNKNOWN')
+

The status of this address cannot be determined.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement(software_update_policy=None, backup_schedules=None, access_settings=None, datetime_config=None, syslog=None, user_account_settings=None, smtp=None, network=None, ceip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ApplianceManagement class This structure contains the Spec required for +Appliance Management configurations.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • software_update_policy (SoftwareUpdatePolicy or None) – Policy to update vCenter. +Only set if the SoftwareUpdatePolicy is set inside +vCenter.

    • +

  • backup_schedules (list of BackupSchedule or None) – Backup schedule of vCenter. +Only set if the Backup is schedule for vCenter

    • +

  • access_settings (AccessSettings or None) – AccessSettings of vCenter. if access settings are set for vCenter

    • +

  • datetime_config (DatetimeConfig or None) – Date Time Configuration of vCenter. +Only set if access settings are set for vCenter

    • +

  • syslog (list of LogForwarding or None) – The syslog class provides methods to manage forwarding of log +messages to remote logging servers. +Only set if log forwarding to remote server are set in +vCenter.

    • +

  • user_account_settings (UserAccountSettings or None) – User Account Settings of vCenter. if user account settings are set +for vCenter

    • +

  • smtp (Smtp or None) – The LocalAccounts class provides methods to manage local user +account.

    • +

  • network (ApplianceNetwork or None) – Network configurations to be applied. +Only set if the network configurations are set in vCenter.

    • +

  • ceip (Ceip or None) – CEIP (Customer Experience Improvement Program) enabled state. +Only set if ceip are set in vcenter.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceNetwork(firewall_rule_policies=None, dns_server_configuration=None, proxy_configuration=None, interfaces=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ApplianceNetwork class This structure contains the Spec required for +Appliance Network configurations.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • firewall_rule_policies (list of FirewallRulePolicy or None) – List of Firewall Rules to be applied. +Only set if the FirewallRulePolicy is set in vCenter.

    • +

  • dns_server_configuration (DnsServerConfiguration or None) – DNS configuration to be applied. +Only set if the DnsServerConfiguration is set in vCenter.

    • +

  • proxy_configuration (list of ProxyConfiguration or None) – Proxy configuration to be applied. +Only set if the Proxy server configuration is set in +vCenter.

    • +

  • interfaces (list of Interface or None) – Interfaces configuration to be applied. +Only set if the Interfaces configuration is set in +vCenter.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.BackupSchedule(parts=None, backup_password=None, location=None, location_user=None, location_password=None, enable=None, recurrence_info=None, retention_info=None, schedule_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BackupSchedule class contains fields to be specified for creating a +new schedule. The structure includes parts, location information, +encryption password and enable flag.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • parts (list of str or None) – List of optional parts to be backed up. Use the +com.vmware.appliance.recovery.backup.Parts#list method to get +information about the supported parts. +If None all the optional parts will not be backed up.

    • +

  • backup_password (str or None) – Password for a backup piece. The backupPassword must adhere to the +following password requirements: At least 8 characters, cannot be +more than 20 characters in length. At least 1 uppercase letter. At +least 1 lowercase letter. At least 1 numeric digit. At least 1 +special character (i.e. any character not in [0-9,a-z,A-Z]). Only +visible ASCII characters (for example, no space). +If None the backup piece will not be encrypted.

    • +

  • location (str) – URL of the backup location.

    • +

  • location_user (str or None) – Username for the given location. +If None authentication will not be used for the specified location.

    • +

  • location_password (str or None) – Password for the given location. +If None authentication will not be used for the specified location.

    • +

  • enable (bool or None) – Enable or disable a schedule. +If None the schedule will be enabled.

    • +

  • recurrence_info (RecurrenceInfo or None) – Recurrence information for the schedule. +If None backup job will not be scheduled. See +RecurrenceInfo

    • +

  • retention_info (RetentionInfo or None) – Retention information for the schedule. +If None all the completed backup jobs will be retained forever. See +RetentionInfo

    • +

  • schedule_id (str) – Identifier of the schedule.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ceip(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ceip class provides methods to Get/Set enabled state of CEIP (Customer +Experience Improvement Program) value.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool or None) – Set enabled state of the CEIP.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Consolecli(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Get/Set of the console-based controlled CLI. Consolecli class provides +methods

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool or None) – Set enabled state of the console-based controlled CLI (TTY1).

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DatetimeConfig(time_zone=None, time_sync=None, ntp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This DatetimeConfig class to set/get date time settings.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • time_zone (Timezone or None) – The Timezone class provides methods to get and set the +appliance timezone. +Only set if the Timezone is set in vCenter

    • +

  • time_sync (Timesync or None) – Timesync class provides methods Performs time synchronization +configuration. +Only set if the time sync mode is set in vCenter

    • +

  • ntp (Ntp or None) – Ntp class provides methods Gets NTP configuration status and +tests connection to ntp servers. +Only set if the ntp server are set in vCenter.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Dcui(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Get/Set enabled state of Direct Console User Interface (DCUI TTY2). +Dcui class provides methods

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool or None) – Set enabled state of Direct Console User Interface (DCUI).

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration(mode=None, servers=None, domains=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

DnsServerConfiguration class This structure represents the +configuration state used to determine DNS servers.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mode (DnsServerConfiguration.DNSServerMode) – Define how to determine the DNS servers. Leave the servers argument +empty if the mode argument is “DHCP”. Set the servers argument to a +comma-separated list of DNS servers if the mode argument is +“static”. The DNS server are assigned from the specified list.

    • +

  • servers (list of str) – List of the currently used DNS servers. DNS server configuration.

    • +

  • domains (list of str or None) – List of the search domains. DNS Search Domains.

    • +
+
+
+
+
+class DNSServerMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

DnsServerConfiguration.DNSServerMode class Describes DNS Server source +(DHCP,static).

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DNSServerMode instance.

+
+
+
+
+DHCP = DNSServerMode(string='DHCP')
+

DNS address is automatically assigned by a DHCP server.

+
+ +
+
+IS_STATIC = DNSServerMode(string='IS_STATIC')
+

DNS address is static.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy(address=None, prefix=None, policy=None, interface_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

FirewallRulePolicy class Structure that defines a single address-based +firewall rule.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IPv4 or IPv6 address.

    • +

  • prefix (long) – CIDR prefix used to mask address. For example, an IPv4 prefix of 24 +ignores the low-order 8 bits of address.

    • +

  • policy (FirewallRulePolicy.Policy) – The allow or deny policy of this rule.

    • +

  • interface_name (str or None) – The interface to which this rule applies. An empty string indicates +that the rule applies to all interfaces. +Only set if interface name required

    • +
+
+
+
+
+class Policy(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

FirewallRulePolicy.Policy class Defines firewall rule policies.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Policy instance.

+
+
+
+
+ACCEPT = Policy(string='ACCEPT')
+

Allow packet with corresponding address.

+
+ +
+
+IGNORE = Policy(string='IGNORE')
+

Drop packet with correpsonding address.

+
+ +
+
+REJECT = Policy(string='REJECT')
+

Drop packet with corresponding address sending destination is not +reachable.

+
+ +
+
+RETURN = Policy(string='RETURN')
+

Apply default or port-specific rules to packet with corresponding address.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface(name=None, status=None, mac=None, ipv4=None, ipv6=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Interfaces class Provides information about network interface.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Interface name, for example, “nic0”, “nic1”. +If set, the name was never set

    • +

  • status (Interface.InterfaceStatus or None) – Interface status. +If set, the name was never set

    • +

  • mac (str or None) – MAC address. For example 00:0C:29:94:BB:5A. +If set, the mac was never set

    • +

  • ipv4 (Ipv4 or None) – IPv4 Address information. +ipv4 This set IPv4 is not set.

    • +

  • ipv6 (Ipv6 or None) – IPv6 Address information. +ipv6 This set IPv6 is not set.

    • +
+
+
+
+
+class InterfaceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Interface.InterfaceStatus class Defines interface status

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the InterfaceStatus instance.

+
+
+
+
+DOWN = InterfaceStatus(string='DOWN')
+

The interface is down.

+
+ +
+
+UP = InterfaceStatus(string='UP')
+

The interface is up.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4(mode=None, address=None, prefix=None, default_gateway=None, configurable=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IPv4 class defines IPv4 configuration. to perform IPv4 network +configuration for interfaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mode (Ipv4.Mode) – The Address assignment mode.

    • +

  • address (str) – The IPv4 address, for example, “10.20.80.191”.

    • +

  • prefix (long) – The IPv4 CIDR prefix, for example, 24. See +http://www.oav.net/mirrors/cidr.html for netmask-to-prefix +conversion.

    • +

  • default_gateway (str or None) – The IPv4 address of the default gateway. This configures the global +default gateway on the appliance with the specified gateway address +and interface. This gateway replaces the existing default gateway +configured on the appliance. However, if the gateway address is +link-local, then it is added for that interface. This does not +support configuration of multiple global default gateways through +different interfaces. +If set, the defaultGateway was never set.

    • +

  • configurable (bool or None) – The IPv4 is configured or not.

    • +
+
+
+
+
+class Mode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ipv4.Mode class defines different IPv4 address assignment modes.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Mode instance.

+
+
+
+
+DHCP = Mode(string='DHCP')
+

The IPv4 address is automatically assigned by a DHCP server.

+
+ +
+
+STATIC = Mode(string='STATIC')
+

The IPv4 address is static.

+
+ +
+
+UNCONFIGURED = Mode(string='UNCONFIGURED')
+

The IPv4 protocol is not configured.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv6(dhcp=None, autoconf=None, configurable=None, addresses=None, default_gateway=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6 class defines Ipv6 configuration. to perform Ipv6 network +configuration for interfaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dhcp (bool) – An address will be assigned by a DHCP server.

    • +

  • autoconf (bool) – An address will be assigned by Stateless Address Autoconfiguration +(SLAAC).

    • +

  • configurable (bool) – The IPv6 is configured or not.

    • +

  • addresses (list of Address or None) – The list of addresses to be statically assigned. +If set, the addresses were never set.

    • +

  • default_gateway (str) – The default gateway for static IP address assignment. This +configures the global IPv6 default gateway on the appliance with +the specified gateway address and interface. This gateway replaces +the existing default gateway configured on the appliance. However, +if the gateway address is link-local, then it is added for that +interface. This does not support configuration of multiple global +default gateways through different interfaces.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccounts(fullname=None, roles=None, enabled=None, has_password=None, min_days_between_password_change=None, max_days_between_password_change=None, warn_days_before_password_expiration=None, password=None, email=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalAccounts class provides methods to manage local user account.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • fullname (str or None) – Full name of the user +If None, the value was never set.

    • +

  • roles (list of str or None) – User roles

    • +

  • enabled (bool or None) – Flag indicating if the account is enabled

    • +

  • has_password (bool or None) – Is the user password set.

    • +

  • min_days_between_password_change (long or None) – Minimum number of days between password change +If None, pasword can be changed any time.

    • +

  • max_days_between_password_change (long or None) – Maximum number of days between password change +If None, password never expires.

    • +

  • warn_days_before_password_expiration (long or None) – Number of days of warning before password expires +If None, a user is never warned.

    • +

  • password (str or None) – Password +If None, value will not be changed

    • +

  • email (str or None) – Email address of the local account +If None, value will not be changed

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccountsPolicy(max_days=None, min_days=None, warn_days=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalAccountsPolicy class provides methods to manage local user +accounts password lifecycle.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • max_days (long or None) – Maximum number of days a password may be used. If the password is +older than this, a password change will be forced. +If None then the restriction will be ignored.

    • +

  • min_days (long or None) – Minimum number of days allowed between password changes. Any +password changes attempted sooner than this will be rejected. +If None then the restriction will be ignored.

    • +

  • warn_days (long or None) – Number of days warning given before a password expires. A zero +means warning is given only upon the day of expiration. +If None then no warning will be provided.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding(hostname=None, port=None, protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LogForwarding class provides methods to manage forwarding of log +messages to remote logging servers.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str or None) – FQDN or IP address of the logging server to which messages are +forwarded.

    • +

  • port (long or None) – The port on which the remote logging server is listening for +forwarded log messages.

    • +

  • protocol (LogForwarding.Protocol or None) – Transport protocol used to forward log messages.

    • +
+
+
+
+
+class Protocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LogForwarding.Protocol class defines transport protocols for +outbound log messages.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Protocol instance.

+
+
+
+
+RELP = Protocol(string='RELP')
+

Log messages will be forwarded to the remote host using the RELP protocol.

+
+ +
+
+TCP = Protocol(string='TCP')
+

Log messages will be forwarded to the remote host using the TCP protocol.

+
+ +
+
+TLS = Protocol(string='TLS')
+

Log messages will be forwarded to the remote host by using the TLS +protocol.

+
+ +
+
+UDP = Protocol(string='UDP')
+

Log messages will be forwarded to the remote host using the UDP protocol.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ntp(servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ntp class provides methods Get/Set NTP configuration status and tests +connection to ntp servers.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

servers (list of str) – Set NTP servers. This variable updates old NTP servers from +configuration and sets the input NTP servers in the configuration.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration(protocol=None, server=None, port=None, username=None, password=None, enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ProxyConfiguration class defines proxy configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • protocol (ProxyConfiguration.Protocol) – The protocol for which proxy should be set.

    • +

  • server (str or None) – URL of the proxy server +Only set if server set in ProxyConfiguration.

    • +

  • port (long) – Port to connect to the proxy server. In a ‘get’ call, indicates the +port connected to the proxy server. In a ‘set’ call, specifies the +port to connect to the proxy server. A value of -1 indicates the +default port.

    • +

  • username (str or None) – Username for proxy server. +Only set if proxy requires username.

    • +

  • password (str or None) – Password for proxy server. +Only set if proxy requires password.

    • +

  • enabled (bool or None) – In the result of the #get and #list methods this attribute +indicates whether proxying is enabled for a particular protocol. In +the input to the test and set methods this attribute +specifies whether proxying should be enabled for a particular +protocol.

    • +
+
+
+
+
+class Protocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

ProxyConfiguration.Protocol class defines the protocols for which +proxying is supported.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Protocol instance.

+
+
+
+
+FTP = Protocol(string='FTP')
+

Proxy configuration for ftp.

+
+ +
+
+HTTP = Protocol(string='HTTP')
+

Proxy configuration for http.

+
+ +
+
+HTTPS = Protocol(string='HTTPS')
+

Proxy configuration for https.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo(minute=None, hour=None, days=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The RecurrenceInfo class contains the recurrence information associated +with a schedule.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • minute (long) – Minute when backup should run.

    • +

  • hour (long) – Hour when backup should run. The hour should be specified in +24-hour clock format.

    • +

  • days (list of RecurrenceInfo.DayOfWeek or None) – Day of week when the backup should be run. Days can be specified as +list of days. +If None the backup will be run everyday.

    • +
+
+
+
+
+class DayOfWeek(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The RecurrenceInfo.DayOfWeek class defines the set of days when backup +can be scheduled. The days can be specified as a list of individual days. +You specify the days when you set the recurrence for a schedule. See +RecurrenceInfo.days.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DayOfWeek instance.

+
+
+
+
+FRIDAY = DayOfWeek(string='FRIDAY')
+

Friday

+
+ +
+
+MONDAY = DayOfWeek(string='MONDAY')
+

Monday

+
+ +
+
+SATURDAY = DayOfWeek(string='SATURDAY')
+

Saturday

+
+ +
+
+SUNDAY = DayOfWeek(string='SUNDAY')
+

Sunday

+
+ +
+
+THURSDAY = DayOfWeek(string='THURSDAY')
+

Thursday

+
+ +
+
+TUESDAY = DayOfWeek(string='TUESDAY')
+

Tuesday

+
+ +
+
+WEDNESDAY = DayOfWeek(string='WEDNESDAY')
+

Wednesday

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo(max_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The RetentionInfo class contains retention information associated with +a schedule.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

max_count (long) – Number of backups which should be retained. If retention is not +set, all the backups will be retained forever.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Shell(enabled=None, timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Get/Set enabled state of BASH, that is, access to BASH from within the +controlled CLI. Shell class provides methods.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) – Enabled can be set to true or false

    • +

  • timeout (long) – The timeout (in seconds) specifies how long you enable the Shell +access. The maximum timeout is 86400 seconds(1 day).

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Smtp(mail_server=None, relay_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Smtp class provides methods to manage send mail configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mail_server (str or None) – Mail server IP address. +If None then the value will be ignored.

    • +

  • relay_port (str or None) – Relay port number. +If None then the value will be ignored.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy(url=None, default_url=None, auto_stage=None, check_schedule=None, username=None, password=None, enable_ssl_cert_validation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This SoftwareUpdatePolicy class to set/get background check for the new +updates.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • url (str or None) – Current appliance update repository URL. Enter “default” to reset +the url to the default url. +Only set if custom URL required

    • +

  • default_url (str or None) – Default appliance update repository URL. +Only set if default URL required

    • +

  • auto_stage (bool or None) – Check for update at the pre-configured repository URL. +Only set if auto stage is enable.

    • +

  • check_schedule (list of Time or None) – The Time class defines day and time the automatic check for new +updates will be run. +Only set if Time required.

    • +

  • username (str or None) – Username for the url update repository +Only set if SoftwareUpdatePolicy requires username.

    • +

  • password (str or None) – Password for the url update repository +Only set if SoftwareUpdatePolicy requires password.

    • +

  • enable_ssl_cert_validation (bool or None) –

    Indicates whether certificates will be checked during patching.

    +

    Warning: If this attribute is set to false, an insecure connection +is made to the update repository which can potentially put the +appliance security at risk.

    +

    • +
+
+
+
+
+class AutoUpdateNotification(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Defines state for automatic update notification. +SoftwareUpdatePolicy.AutoUpdateNotification class

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the AutoUpdateNotification instance.

+
+
+
+
+DISABLED = AutoUpdateNotification(string='DISABLED')
+

Automatic update notification is disabled. Disable periodically query the +configured url for updates.

+
+ +
+
+ENABLED = AutoUpdateNotification(string='ENABLED')
+

Automatic update notification is enabled. Enable periodically query the +configured url for updates.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ssh(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ssh class provides methods to Get/Set enabled state of SSH-based +controlled CLI.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool or None) – Set enabled state of the SSH-based controlled CLI.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time(hour=None, minute=None, day=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Time class defines weekday and time the automatic check for new +updates will be run

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hour (str or None) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time +Format +Only set if hour is present in SoftwareUpdatePolicy

    • +

  • minute (str or None) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time +Format +Only set if minute is present in SoftwareUpdatePolicy

    • +

  • day (Time.UpdateDay or None) – Day to query for updates +Only set if minute is present in SoftwareUpdatePolicy

    • +
+
+
+
+
+class UpdateDay(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Time.UpdateDay class Defines days to query for updates.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UpdateDay instance.

+
+
+
+
+EVERYDAY = UpdateDay(string='EVERYDAY')
+

Query for updates everyday.

+
+ +
+
+FRIDAY = UpdateDay(string='FRIDAY')
+

Query for updates on Friday.

+
+ +
+
+MONDAY = UpdateDay(string='MONDAY')
+

Query for updates on Monday.

+
+ +
+
+SATURDAY = UpdateDay(string='SATURDAY')
+

Query for updates on Saturday.

+
+ +
+
+SUNDAY = UpdateDay(string='SUNDAY')
+

Query for updates on Sunday.

+
+ +
+
+THURSDAY = UpdateDay(string='THURSDAY')
+

Query for updates on Thursday.

+
+ +
+
+TUESDAY = UpdateDay(string='TUESDAY')
+

Query for updates on Tuesday.

+
+ +
+
+WEDNESDAY = UpdateDay(string='WEDNESDAY')
+

Query for updates on Wednesday.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync(mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Timesync class provides methods Performs time synchronization +configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

mode (Timesync.TimeSyncMode) –

+
+
+
+
+class TimeSyncMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Timesync.TimeSyncMode class defines time synchronization modes

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the TimeSyncMode instance.

+
+
+
+
+DISABLED = TimeSyncMode(string='DISABLED')
+

Time synchronization is disabled.

+
+ +
+
+HOST = TimeSyncMode(string='HOST')
+

VMware Tool-based time synchronization.

+
+ +
+
+NTP = TimeSyncMode(string='NTP')
+

NTP-based time synchronization.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timezone(name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Timezone class provides methods to get and set the appliance +timezone.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

name (str or None) – Set time zone.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.UserAccountSettings(local_accounts_policy=None, root_account_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This UserAccountSettings class to set/get user account settings.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • local_accounts_policy (LocalAccountsPolicy or None) – The localAccountsPolicy class provides methods to manage local +user accounts. +Only set if Password Policy is set to manage local user +accounts.

    • +

  • root_account_policy (LocalAccounts or None) – The LocalAccounts class provides methods to manage local user +account.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal(name=None, group=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Principal class represents the configuration for a Principal.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Principal name.

    • +

  • group (bool) – Is a Group

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement(version=None, privileges=None, global_permissions=None, roles=None, vc_groups=None, identity_sources=None, password_policy=None, token_policy=None, lockout_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

AuthenticationManagement class This structure contains the Spec +required for Authentication Management configurations. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – The version of authorization management this configuration is +applicable to. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • privileges (list of Privileges or None) – List of Privileges. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • global_permissions (list of GlobalPermission) – List of Global Permission. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • roles (list of Roles) – List of Roles. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • vc_groups (list of VCGroups) – List of VCGroups. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • identity_sources (list of IdentitySource or None) – List of Identity Sources added to VC. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • password_policy (PasswordPolicy or None) – Password Policy. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • token_policy (TokenPolicy or None) – Token Policy. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • lockout_policy (LockoutPolicy or None) – Lockout Policy. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.GlobalPermission(principal=None, role_ids=None, role_names=None, propagate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

GlobalPermissions class This structure represents the configuration for +Global Permissions. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • principal (com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal) – Principal with roles. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • role_ids (list of long or None) – Role Ids assigned to this Principal. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • role_names (list of str) – Role Names assigned to this Principal. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • propagate (bool) – Propagating to child objects. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.IdentitySource(identity_source_type=None, names=None, alias=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IdentitySource class This structure represents the configuration for +Identity Source present in vCenter. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • identity_source_type (IdentitySourceType) – Identity Source Type. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • names (list of str) – Identity Source name. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • alias (str or None) – Alias for Identity Source. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.IdentitySourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The IdentitySourceType class contains the possible Identity Source +Types. Warning: This enumeration is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IdentitySourceType instance.

+
+
+
+
+AD_OVER_IWA = IdentitySourceType(string='AD_OVER_IWA')
+

Active Directory (Integrated Windows Authentication). Warning: This +class attribute is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+AD_OVER_LDAP = IdentitySourceType(string='AD_OVER_LDAP')
+

Active Directory over LDAP. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+IDP_ADFS = IdentitySourceType(string='IDP_ADFS')
+

Active Directory Federation Services (Microsoft ADFS). Warning: This +class attribute is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+IDP_CSP = IdentitySourceType(string='IDP_CSP')
+

VMware Cloud Services Platform. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+IDP_VMWAREID = IdentitySourceType(string='IDP_VMWAREID')
+

Oauth2 for MyVMwareId. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+IDP_WS1B = IdentitySourceType(string='IDP_WS1B')
+

VMware Workspace ONE Broker. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+OPEN_LDAP = IdentitySourceType(string='OPEN_LDAP')
+

Open LDAP. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.LockoutPolicy(failed_login_attempts=None, failure_interval=None, unlock_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LockoutPolicy class This structure represents the configuration in +Lockout Policy. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failed_login_attempts (long) – Maximum number of failed login attempts. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • failure_interval (long) – Time interval between failures. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • unlock_time (long) – Unlock time. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.PasswordPolicy(special_chars=None, alpha_chars=None, uppercase_chars=None, lowercase_chars=None, numeric_chars=None, adj_identical_chars=None, password_reuse=None, max_life=None, max_length=None, min_length=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

PasswordPolicy class This structure represents the configuration in +Password Policy. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • special_chars (long) – Minimum special characters. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • alpha_chars (long) – Minimum alphabetic characters. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • uppercase_chars (long) – Minimum uppercase characters. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • lowercase_chars (long) – Minimum lowercase characters. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • numeric_chars (long) – Minimum numeric characters. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • adj_identical_chars (long) – Maximum adjacent identical characters. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • password_reuse (long) – Previous password reuse restriction. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • max_life (long) – Maximum lifetime. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • max_length (long) – Maximum length. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • min_length (long) – Minimum length. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Privileges(id=None, description=None, group=None, is_on_parent=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Privileges class This structure represents the configuration for +Privileges. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Privilege identifier. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • description (str or None) – Privilege description. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • group (str) – Group to which the privilege belongs to. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • is_on_parent (bool) – does this apply to the parent entity?. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Roles(id=None, name=None, description=None, privilege_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Roles class This structure represents the configuration for Roles. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (long or None) – Role identifier. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • name (str) – Role name which is unique across roles. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • description (str or None) – Role description. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • privilege_ids (list of str or None) – List of Privileges present in the Role. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.TokenPolicy(clock_tolerance=None, token_renewal=None, token_delegation=None, bearer_refresh=None, hok_refresh=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

TokenPolicy class This structure represents the configuration in Token +Policy. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • clock_tolerance (long) – Clock tolerance ms. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • token_renewal (long) – Maximum token renewal count. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • token_delegation (long) – Maximum token delegation count. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • bearer_refresh (long) – Maximum Bearer RefreshToken lifetime. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • hok_refresh (long) – Maximum HoK RefreshToken lifetime. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.VCGroups(principal=None, description=None, members=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

VCGroups class This structure represents the configuration for +VCGroups. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • principal (str) – Unique name of the VC group. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • description (str or None) – VCGroup description. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • members (list of com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal or None) – List of members present in the vcGroup. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module

+

The +com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client +module provides classes to manage the vCenter Server Inventory configurations.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement(folders=None, datacenters=None, clusters=None, storage_pods=None, datastores=None, networks=None, hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InventoryManagement class contains attributes describing the +inventory of a vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Settings(settings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Settings class defines vCenter Server settings as key-value pairs.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

settings (dict of str and str) –

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.InventoryAuthorization(version=None, service_provider_entities=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

InventoryAuthorization class contains the Spec required for +InventoryAuthorizationPlugin configurations.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – The version of the authorization model this configuration is +applicable to.

    • +

  • service_provider_entities (ServiceProviderEntities or None) – Service provider managed entities configuration of the vCenter.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.Permission(entity=None, principal=None, role_name=None, propagate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Permission class represents a single inventory permission inside a +container.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • entity (str) – Full path to the entity for which the permission is set. The entity +must be either one of the service provider managed entities, or a +child thereof.

    • +

  • principal (com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal) – The principal for which the permission is set.

    • +

  • role_name (str) – Name of a role in vCenter.

    • +

  • propagate (bool) – Whether this permission propagates to child objects.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.ServiceProviderEntities(entities=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ServiceProviderEntities class contains the configuration for the +service provider managed entities inside VCenter, together with explicit +inventory permissions inside the container.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • entities (list of str) – List of full paths to the service provider managed entities inside +the vCenter.

    • +

  • permissions (list of Permission) – List of the inventory permissions to set inside the container.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Cluster(name=None, parent_path=None, drs=None, management_resourcepools=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster class contains attributes describing the configuration of +the the management cluster that hosts the management virtual machines. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the management cluster which hosts the management VMs. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • parent_path (str) – Absolute path from root folder to management cluster’s parent. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • drs (DrsConfig or None) – Individual Cluster-level configuration of the vSphere DRS service. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • management_resourcepools (list of ResourcePool or None) – The management cluster provides dedicated resource pools for +running the management virtual machines. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig(enabled=None, automation_level=None, migration_threshold=None, virtual_machine_automation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DrsConfig class contains attributes describing the DRS specific +configurations of the management cluster. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Flag indicating whether or not DRS service is enabled. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • automation_level (DrsConfig.DrsBehaviorInfo or None) – Specifies the cluster-wide default DRS behavior for virtual +machines. You can override the default behavior for a virtual +machine. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +If None or empty, the value is skipped.

    • +

  • migration_threshold (long or None) – Threshold for generated recommendations. DRS generates only those +recommendations that are above the specified vmotionRate. Ratings +vary from 1 to 5. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +If None or empty, the value is skipped.

    • +

  • virtual_machine_automation (bool or None) – Flag that dictates whether DRS Behavior overrides for individual +VMs. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +
+
+
+
+
+class DrsBehaviorInfo(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DrsConfig.DrsBehaviorInfo class defines the automation levels that +can be set on a DRS cluster. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DrsBehaviorInfo instance.

+
+
+
+
+FULLY_AUTOMATED = DrsBehaviorInfo(string='FULLY_AUTOMATED')
+

Specifies that VirtualCenter should automate both the migration of virtual +machines and their placement with a host at power on. Warning: This +class attribute is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+MANUAL = DrsBehaviorInfo(string='MANUAL')
+

Specifies that VirtualCenter should generate recommendations for virtual +machine migration and for placement with a host, but should not implement +the recommendations automatically. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+PARTIALLY_AUTOMATED = DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')
+

Specifies that VirtualCenter should generate recommendations for virtual +machine migration and for placement with a host, but should automatically +implement only the placement at power on. Warning: This class attribute +is available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementCluster(name=None, parent_path=None, drs=None, management_resourcepools=None, clusters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ManagementCluster class contains attributes describing the +configuration of the management cluster that hosts the management virtual +machines. It contains the resource settings of the cluster and the +management virtual machines running inside it. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – To be deprecated. Name of the management cluster which hosts the +management VMs. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • parent_path (str or None) – To be deprecated. Absolute path from root folder to management +cluster’s parent. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • drs (DrsConfig or None) – To be deprecated. Cluster-wide configuration of the vSphere DRS +service. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • management_resourcepools (list of ResourcePool or None) – To be deprecated. The management cluster provides dedicated +resource pools for running the management virtual machines. +Management cluster can can run workload VMs outside this resource +pools. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • clusters (list of Cluster or None) – The management cluster have a list of cluster where management VMs +may be deployed. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine(name=None, mo_id=None, vm_type=None, parent_path=None, resource_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ManagementVirtualMachine class contains information about the +management virtual machine configurations present in the management +cluster. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the management virtual machine configuration. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • mo_id (str or None) – Managed Object identifier of the management virtual machine. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • vm_type (ManagementVirtualMachine.ManagementVMType) – Type of the management virtual machine. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • parent_path (str) – Absolute path from root folder to management virtual machine parent +vm folder. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • resource_config (ResourceConfigSpec or None) – Configuration of the management virtual machine. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +If None, then there is no configuration.

    • +
+
+
+
+
+class ManagementVMType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ManagementVirtualMachine.ManagementVMType class defines the type of +management virtual machine. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ManagementVMType instance.

+
+
+
+
+CLOUD_GATEWAY = ManagementVMType(string='CLOUD_GATEWAY')
+

The management virtual machine is of type Cloud Gateway. Warning: This +class attribute is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+VCENTER = ManagementVMType(string='VCENTER')
+

The management virtual machine is of type vCenter. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceAllocationInfo(reservation=None, expandable_reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAllocationInfo class contains resource allocation +information of a resource pool or management virtual machine. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long) – Amount of resource that is guaranteed available to a resource pool +or a virtual machine. Reserved resources are not wasted if they are +not used. If the utilization is less than the reservation, the +resources can be utilized by other running virtual machines. Units +are MB fo memory, and MHz for CPU. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • expandable_reservation (bool) – In a resource pool with an expandable reservation, the reservation +can grow beyond the specified value, if the parent resource pool +has unreserved resources. A non-expandable reservation is called a +fixed reservation. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • limit (long) – The utilization of a resource pool will not exceed this limit, even +if there are available resources. This is typically used to ensure +a consistent performance of resource pools independent of available +resources. If set to -1, then there is no fixed limit on resource +usage (only bounded by available resources and shares). Units are +MB for memory, and MHz for CPU. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • shares (Shares) – Shares are used in case of resource contention. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceConfigSpec(cpu_allocation=None, memory_allocation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceConfigSpec class provides resource reserved for a resource +pool or management virtual machine. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu_allocation (ResourceAllocationInfo) – Resource allocation information for CPU. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • memory_allocation (ResourceAllocationInfo) – Resource allocation information for memory. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourcePool(name=None, parent_path=None, config=None, vm=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool class contains information about the management +resource pools present in the cluster. Warning: This class is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the vCenter Server resource pool. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • parent_path (str) – Absolute path from root folder to resource pool’s parent. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • config (ResourceConfigSpec) – Summary of the resource pool containing the resource spec. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • vm (list of ManagementVirtualMachine or None) – The management virtual machines contained in this resource pool. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +If None or empty, no virtual machine is expected to run in this +resource pool..

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares(level=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Shares class provides specification of shares.

+

Shares are used to determine relative allocation between resource +consumers. In general, a consumer with more shares gets proportionally more +of the resource, subject to certain other constraints.. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • level (Shares.Level) – The allocation level. It maps to a pre-determined set of numeric +values for shares. If the shares value does not map to a predefined +size, then the level is set as CUSTOM. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • shares (long) –

    When Shares.level is set to CUSTOM, it is the number of +shares allocated. Otherwise, this value is ignored.

    +

    There is no unit for this value. It is a relative measure based on +the settings for other resource pools.. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    +

    • +
+
+
+
+
+class Level(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Shares.Level class defines the possible values for the allocation +level. Warning: This enumeration is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Level instance.

+
+
+
+
+CUSTOM = Level(string='CUSTOM')
+

If set, in case there is resource contention the server uses the +shares value to determine the resource allocation. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+HIGH = Level(string='HIGH')
+

For CPU: Shares = 2000 * nmumber of virtual CPUs. +For Memory: Shares = 20 * virtual machine memory size in MB. +. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+LOW = Level(string='LOW')
+

For CPU: Shares = 500 * number of virtual CPUs. +For Memory: Shares = 5 * virtual machine memory size in MB. +. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+NORMAL = Level(string='NORMAL')
+

For CPU: Shares = 1000 * number of virtual CPUs. +For Memory: Shares = 10 * virtual machine memory size in MB. +. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client.VsphereUIConfiguration(enable_idp_configuration=None, enable_cloud_admin_role_protection=None, enable_deprecated_vc_alert=None, enable_intercom_chat=None, enable_file_browser_download_upload_from_vc=None, enable_hybrid_management=None, enable_ceip=None, help_url_pointing_to_aws=None, enable_ad_iwa_ids=None, enable_csp_oidc_federation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

VsphereUIConfiguration class This spec is used to configure the +behavior of the vsphere-ui service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enable_idp_configuration (bool or None) – Property to configure the IDPConfiguration view, with this enabled, +user will be able to view and configure IDP

    • +

  • enable_cloud_admin_role_protection (bool or None) – Property to enable CloudAdminRoleProtection in the UI

    • +

  • enable_deprecated_vc_alert (bool or None) – Property to enable DeprecatedVcAlert in the UI

    • +

  • enable_intercom_chat (bool or None) – Property to enable Intercom Chat in the UI

    • +

  • enable_file_browser_download_upload_from_vc (bool or None) – Property to enable file browser download and upload from VC

    • +

  • enable_hybrid_management (bool or None) – Property to enable hybrid management view.

    • +

  • enable_ceip (bool or None) – Property to enable CEIP view from Administration -> Deployment.

    • +

  • help_url_pointing_to_aws (bool or None) – Property that indicates that Help url should point to url for AWS.

    • +

  • enable_ad_iwa_ids (bool or None) – Property that indicates Identity Source of type IWA should be +enabled.

    • +

  • enable_csp_oidc_federation (bool or None) – Property that indicates CSP OIDC identity provider configured in +vCenter.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html new file mode 100644 index 00000000..0586e472 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html @@ -0,0 +1,1525 @@ + + + + + + + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package

+
+

Submodules

+
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module

+

The +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client +module provides classes to manage the vCenter Server Inventory Cluster DRS +settings.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions(advanced_options=None, scalable_shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AdditionalOptions class contains attributes describing the HA +specific configurations of a cluster. It contains cluster-wide +configurations for vSphereHA.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule(status=None, enabled=None, in_compliance=None, name=None, mandatory=None, user_created=None, vms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AffinityRule class defines a set of virtual machines that DRS will +attempt to run on the same host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Status or None) – Flag to indicate whether or not the rule is currently satisfied.

    • +

  • enabled (bool or None) – Flag to indicate whether or not the rule is enabled. Set this +property when user configures the rule. The default value is false +(disabled). If there is a rule conflict, the Server can override +the setting to disable a rule. +If None or empty, the value is skipped.

    • +

  • in_compliance (bool or None) – Flag to indicate if the rule is in compliance. +If None or empty, the value is skipped.

    • +

  • name (str or None) – Name of the rule.

    • +

  • mandatory (bool or None) – Flag to indicate whether compliance with this rule is mandatory or +optional. The default value is false (optional). +If None or empty, the value is skipped.

    • +

  • user_created (bool or None) – Flag to indicate whether the rule is created by the user or the +system. +If None or empty, the value is skipped.

    • +

  • vms (list of str or None) – List of virtual machines.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation(automation_level=None, migration_threshold=None, proactive_drs_enabled=None, virtual_machine_automation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Automation class contains attributes describing the HA specific +configurations of a cluster. It contains cluster-wide configurations for +vSphereHA.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • automation_level (DrsBehaviorInfo or None) – Specifies the cluster-wide default DRS behavior for virtual +machines. You can override the default behavior for a virtual +machine. +If None or empty, the value is skipped.

    • +

  • migration_threshold (long or None) – Threshold for generated recommendations. DRS generates only those +recommendations that are above the specified vmotionRate. Ratings +vary from 1 to 5. +If None or empty, the value is skipped.

    • +

  • proactive_drs_enabled (bool or None) – Flag indicating whether or not the ProactiveDRS is enabled. +If None or empty, the value is skipped.

    • +

  • virtual_machine_automation (bool or None) – Flag that dictates whether DRS Behavior overrides for individual +VMs.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DependencyRule(status=None, enabled=None, in_compliance=None, name=None, mandatory=None, user_created=None, vm_group=None, depends_on_vm_group=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DependencyRule class defines VM-to-VM dependencies.

+

A VM-VM Dependency rule identifies the following groups.

+
    +

  • A virtual machine group - DependencyRule.vm_group

    • +

  • A “depends on” virtual machine group - +DependencyRule.depends_on_vm_group.

    • +
+

The VMs in DependencyRule.vm_group depends on the list of VMs +specified in DependencyRule.depends_on_vm_group.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Status or None) – Flag to indicate whether or not the rule is currently satisfied.

    • +

  • enabled (bool or None) – Flag to indicate whether or not the rule is enabled. Set this +property when user configures the rule. The default value is false +(disabled). If there is a rule conflict, the Server can override +the setting to disable a rule. +If None or empty, the value is skipped.

    • +

  • in_compliance (bool or None) – Flag to indicate if the rule is in compliance. +If None or empty, the value is skipped.

    • +

  • name (str or None) – Name of the rule.

    • +

  • mandatory (bool or None) – Flag to indicate whether compliance with this rule is mandatory or +optional. The default value is false (optional). +If None or empty, the value is skipped.

    • +

  • user_created (bool or None) – Flag to indicate whether the rule is created by the user or the +system. +If None or empty, the value is skipped.

    • +

  • vm_group (str or None) – Virtual group name. The virtual group may contain one or more +virtual machines.

    • +

  • depends_on_vm_group (str or None) – Depdendency virtual group name. The virtual group may contain one +or more virtual machines.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DpmBehaviorInfo class defines the automation level for DPM service +on a cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DpmBehaviorInfo instance.

+
+
+
+
+AUTOMATED = DpmBehaviorInfo(string='AUTOMATED')
+

Specifies that VirtualCenter should generate recommendations for host power +operations, and should execute the recommendations automatically.

+
+ +
+
+MANUAL = DpmBehaviorInfo(string='MANUAL')
+

Specifies that VirtualCenter should generate recommendations for host power +operations, but should not execute the recommendations automatically.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DrsBehaviorInfo class defines the automation levels that can be set +on a DRS cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DrsBehaviorInfo instance.

+
+
+
+
+FULLY_AUTOMATED = DrsBehaviorInfo(string='FULLY_AUTOMATED')
+

Specifies that VirtualCenter should automate both the migration of virtual +machines and their placement with a host at power on.

+
+ +
+
+MANUAL = DrsBehaviorInfo(string='MANUAL')
+

Specifies that VirtualCenter should generate recommendations for virtual +machine migration and for placement with a host, but should not implement +the recommendations automatically.

+
+ +
+
+PARTIALLY_AUTOMATED = DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')
+

Specifies that VirtualCenter should generate recommendations for virtual +machine migration and for placement with a host, but should automatically +implement only the placement at power on.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig(enabled=None, automation=None, additional_options=None, power_management=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DrsConfig class contains attributes describing the HA specific +configurations of a cluster. It contains cluster-wide configurations for +DAS.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) – Flag indicating whether or not DRS service is enabled. +If None or empty, the value is skipped.

    • +

  • automation (Automation or None) – vSphere HA configuration for Automation Level, Migration Threshold +Predictive DRS and VM Automation.

    • +

  • additional_options (AdditionalOptions or None) – vSphere HA configuration for VM Distribution, CPU Over commit +Scalable Shares.

    • +

  • power_management (PowerManagement or None) – vSphere HA configuration for DPM, AutomationLevel, DPM Threshold.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides(name=None, behavior=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DrsVmOverrides class contains the fields describing DRS behavior +override for individual virtual machines in the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Reference to the virtual machine.

    • +

  • behavior (DrsBehaviorInfo or None) – Specifies the particular DRS behavior for this virtual machine. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group(vm_groups=None, host_groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Group class describes the properties of virtual machine and host +groups.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_groups (list of GroupDetails or None) – List of VM Group details. +If None or empty, the value is skipped.

    • +

  • host_groups (list of GroupDetails or None) – List of HOST Group details. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails(name=None, entities=None, user_created=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Unique name of the group.

    • +

  • entities (list of str or None) – List of VMs or Hosts belonging to the group. +If None or empty, the value is skipped.

    • +

  • user_created (bool or None) – Flag to indicate whether the group is created by the user or the +system. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement(dpm_enabled=None, automation_level=None, dpm_threshold=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PowerManagement class contains the fields describing DPM specific +configurations of a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dpm_enabled (bool or None) – Flag indicating whether or not the service is enabled. This service +can not be enabled, unless DRS is enabled as well. +If None or empty, the value is skipped.

    • +

  • automation_level (DpmBehaviorInfo or None) – Specifies the default VMware DPM behavior for hosts. This default +behavior can be overridden on a per host. +If None or empty, the value is skipped.

    • +

  • dpm_threshold (com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.OptionValue or None) – DPM Advanced options. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig(enabled=None, automation_level=None, remediation=None, providers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ProactiveHAConfig class defines the Configuration of the vSphere +InfraUpdateHA service on a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) – Flag indicating whether or not the service is enabled. +InfraUpdateHA will not be active, unless DRS is enabled as well. +If None or empty, the value is skipped.

    • +

  • automation_level (ProactiveHAConfig.BehaviorType or None) – Configured behavior. Values are of type +InfraUpdateHaConfig.BehaviorType. +If None or empty, the value is skipped.

    • +

  • remediation (ProactiveHAConfig.RemediationType or None) – Configured remediation for moderately degraded hosts. Values are of +type InfraUpdateHaConfig.RemediationType. +If None or empty, the value is skipped.

    • +

  • providers (list of str or None) – The list of health update providers configured for this cluster. +Providers are identified by their id. If the provider list is +empty, InfraUpdateHA will not be active. +If None or empty, the value is skipped.

    • +
+
+
+
+
+class BehaviorType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ProactiveHAConfig.BehaviorType class defines the behavior for +executing the proposed DRS recommendations.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BehaviorType instance.

+
+
+
+
+AUTOMATED = BehaviorType(string='AUTOMATED')
+

With this behavior configured, the proposed DRS recommendations are +executed immediately.

+
+ +
+
+MANUAL = BehaviorType(string='MANUAL')
+

With this behavior configured, the proposed DRS recommendations require +manual approval before they are executed.

+
+ +
+ +
+
+class RemediationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ProactiveHAConfig.RemediationType class defines the types of +remediation behaviours that can be configured.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the RemediationType instance.

+
+
+
+
+MAINTENANCE_MODE = RemediationType(string='MAINTENANCE_MODE')
+

With this behavior configured, a degraded host will be recommended to be +placed in Maintenance Mode.

+
+ +
+
+QUARANTINE_MODE = RemediationType(string='QUARANTINE_MODE')
+

With this behavior configured, a degraded host will be recommended to be +placed in Quarantine Mode.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule(vm_affinity_rules=None, vm_anti_affinity_rules=None, dependency_rule=None, vm_host_rule=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Rule class describes affinity and anti-affinity DRS rules that +affect the placement of virtual machines in a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_affinity_rules (list of AffinityRule or None) – Cluster-wide VM affinity rules.If this is set then +AntiAffinityRule, DependencyRule, VmHostRule can +not be set. +If None or empty, the value is skipped.

    • +

  • vm_anti_affinity_rules (list of AffinityRule or None) – Cluster-wide VM anti affinity rules.If this is set then +AntiAffinityRule, DependencyRule, VmHostRule can +not be set. +If None or empty, the value is skipped.

    • +

  • dependency_rule (list of DependencyRule or None) – Cluster-wide VM-to-VM dependency rules.If this is set then +AffinityRule, AntiAffinityRule, VmHostRule can +not be set. +If None or empty, the value is skipped.

    • +

  • vm_host_rule (list of VmHostRule or None) – Cluster-wide VM-to-Host affinity rules.If this is set then +AffinityRule, AntiAffinityRule, DependencyRule +can not be set. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ScaleSharesBehavior instance.

+
+
+
+
+DISABLED = ScaleSharesBehavior(string='DISABLED')
+

Do not scale shares

+
+ +
+
+SCALE_CPU_AND_MEMORY_SHARES = ScaleSharesBehavior(string='SCALE_CPU_AND_MEMORY_SHARES')
+

Scale both CPU and memory shares

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Status enumeration defines a general “health” value for a managed +entity.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+GRAY = Status(string='GRAY')
+

The status is unknown.

+
+ +
+
+GREEN = Status(string='GREEN')
+

The entity is OK.

+
+ +
+
+RED = Status(string='RED')
+

The entity definitely has a problem.

+
+ +
+
+YELLOW = Status(string='YELLOW')
+

The entity might have a problem.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.VmHostRule(status=None, enabled=None, in_compliance=None, name=None, mandatory=None, user_created=None, vm_group_name=None, affine_host_group_name=None, anti_affine_host_group_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VmHostRule class defines virtual machines and host groups that +determine virtual machine placement. The virtual machines and hosts +referenced by a VM-Host rule must be in the same cluster.

+

A VM-Host rule identifies the following groups.

+
    +

  • A virtual machine group (vim.cluster.VmGroup).

    • +

  • Two host groups - an affine host group and an anti-affine host group +(vim.cluster.HostGroup). At least one of the groups must contain one or +more hosts.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Status or None) – Flag to indicate whether or not the rule is currently satisfied.

    • +

  • enabled (bool or None) – Flag to indicate whether or not the rule is enabled. Set this +property when user configures the rule. The default value is false +(disabled). If there is a rule conflict, the Server can override +the setting to disable a rule. +If None or empty, the value is skipped.

    • +

  • in_compliance (bool or None) – Flag to indicate if the rule is in compliance. +If None or empty, the value is skipped.

    • +

  • name (str or None) – Name of the rule.

    • +

  • mandatory (bool or None) – Flag to indicate whether compliance with this rule is mandatory or +optional. The default value is false (optional). +If None or empty, the value is skipped.

    • +

  • user_created (bool or None) – Flag to indicate whether the rule is created by the user or the +system. +If None or empty, the value is skipped.

    • +

  • vm_group_name (str or None) – Virtual group name. +If None or empty, the value is skipped.

    • +

  • affine_host_group_name (str or None) – Name of the affine host group. The affine host group identifies +hosts on which VmHotRule#vmGroupName virtual machines can be +powered-on. +If None or empty, the value is skipped.

    • +

  • anti_affine_host_group_name (str or None) – Name of the anti-affine host group. The anti-affine host group +identifies hosts on which VmHotRule#vmGroupName virtual machines +should not be powered-on. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module

+

The +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client +module provides classes to manage the vCenter Server Inventory Cluster HA +settings.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.AdmissionControl(host_failures_cluster_tolerates=None, policy_type=None, host_fail_over_slot_policy=None, cluster_resource_percentage=None, dedicated_failover_hosts=None, performance_degradation_vm_tolerate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The FailuresAndResponses class contains attributes describing the +Failures and responses specific configurations of a cluster. It contains +cluster-wide configurations for vsphere HA.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host_failures_cluster_tolerates (long or None) – Number of host failures that should be tolerated, still +guaranteeing sufficient resources to restart virtual machines on +available hosts. If not set, we assume 1.

    • +

  • policy_type (str or None) –

    • +

  • host_fail_over_slot_policy (FixedSizeSlotPolicy or None) – This policy allows setting a fixed slot size

    • +

  • cluster_resource_percentage (ClusterResourcePercentage or None) –

    • +

  • dedicated_failover_hosts (list of str or None) – List of hosts dedicated for failover.

    • +

  • performance_degradation_vm_tolerate (long or None) – Percentage of resource reduction that a cluster of VMs can tolerate +in case of a failover.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage(cpu=None, memory=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This class defines CPU, Memory resource percentages.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu (long) – Reserved failover CPU capacity

    • +

  • memory (long) – Reserved failover Memory capacity

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses(host_monitoring=None, default_vm_restart_priority=None, restart_priority_condition_timeout=None, additional_delay=None, host_isolation_response=None, datastore_with_pdl_failure_response=None, apd_failure_response=None, response_recovery=None, response_delay=None, vm_monitoring=None, vm_tools_monitoring_settings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The FailuresAndResponses class contains attributes describing the +Failures and responses specific configurations of a cluster. It contains +cluster-wide configurations for vsphere HA.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host_monitoring (FailuresAndResponses.ServiceState or None) –

    • +

  • default_vm_restart_priority (FailuresAndResponses.RestartPriority or None) –

    Restart priority for a virtual machine.

    +

    If not specified at either the cluster level or the virtual machine +level, this will default to medium. +If None or empty, the value is skipped.

    +

    • +

  • restart_priority_condition_timeout (long or None) – This setting is used to specify a maximum time the lower priority +VMs should wait for the higher priority VMs to be ready. If the +higher priority Vms are not ready by this time, then the lower +priority VMs are restarted irrespective of the VM ready state. This +timeout can be used to prevent the failover of lower priority VMs +to be stuck infinitely. Timeout specified in seconds. To use +cluster setting for a VM override, set to -1 in per-VM. setting. +If None or empty, the value is skipped.

    • +

  • additional_delay (long or None) – After condition has been met, a mandatory delay before starting the +next VM restart priority.

    • +

  • host_isolation_response (FailuresAndResponses.IsolationResponse or None) –

    Indicates whether or not the virtual machine should be powered off +if a host determines that it is isolated from the rest of the +compute resource.

    +

    If not specified at either the cluster level or the virtual machine +level, this will default to powerOff. +If None or empty, the value is skipped.

    +

    • +

  • datastore_with_pdl_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as +Permenant Device Loss (PDL). PDL indicates storage device failure +or LUN removal. In case of PDL, the failed datastore or device is +unlikely to recover. The details of PDL are

    • +

  • apd_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as +All Paths Down (APD). APD is a condition where a storage has become +inaccessible for unknown reasons. It only indicates loss of +connectivity and does not indicate storage device failure or LUN +removal (Permanent Device Loss or PDL)

    • +

  • response_recovery (FailuresAndResponses.VmReactionOnAPDCleared or None) –

    Action taken by VM Component Protection service for a powered on VM +when APD condition clears after APD timeout.

    +

    This property is meaningful only when vSphere HA is turned on. +Valid values are specified by +FailuresAndResponses.VmReactionOnAPDCleared. The default +value is VmReactionOnAPDCleared#none for cluster setting and +VmReactionOnAPDCleared#useClusterDefault for per-VM setting.

    +

    • +

  • response_delay (long or None) – The time interval after an APD timeout has been declared and before +VM Component Protection service will terminate the VM. The default +value is 180 seconds if not specified. To use cluster setting for a +VM override, set to -1 in per-VM setting.

    • +

  • vm_monitoring (FailuresAndResponses.VmMonitoringState or None) –

    • +

  • vm_tools_monitoring_settings (VmToolsMonitoringSettings or None) –

    • +
+
+
+
+
+class IsolationResponse(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The enum defines values that indicate whether or not the virtual machine +should be powered off if a host determines that it is isolated from the +rest of the cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IsolationResponse instance.

+
+
+
+
+CLUSTER_ISOLATION_RESPONSE = IsolationResponse(string='CLUSTER_ISOLATION_RESPONSE')
+

Use the default isolation response defined for the cluster that contains +this virtual machine.

+
+ +
+
+NONE = IsolationResponse(string='NONE')
+

Do not power off the virtual machine in the event of a host network +isolation.

+
+ +
+
+POWER_OFF = IsolationResponse(string='POWER_OFF')
+

Power off the virtual machine in the event of a host network isolation.

+
+ +
+
+SHUTDOWN = IsolationResponse(string='SHUTDOWN')
+

Shut down the virtual machine guest operating system in the event of a host +network isolation. If the guest operating system fails to shutdown within +five minutes, HA will initiate a forced power off.

+

When you use the shutdown isolation response, failover can take longer +(compared to the response) because the virtual machine cannot fail over +until it is shutdown.

+
+ +
+ +
+
+class RestartPriority(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The enum defines virtual machine restart priority values to resolve +resource contention. The priority determines the preference that HA gives +to a virtual machine if sufficient capacity is not available to power on +all failed virtual machines. For example, high priority virtual machines on +a host get preference over low priority virtual machines.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the RestartPriority instance.

+
+
+
+
+CLUSTER_RESTART_PRIORITY = RestartPriority(string='CLUSTER_RESTART_PRIORITY')
+

Virtual machines with this priority use the default restart priority +defined for the cluster that contains this virtual machine.

+
+ +
+
+DISABLED = RestartPriority(string='DISABLED')
+

vSphere HA is disabled for this virtual machine.

+
+ +
+
+HIGH = RestartPriority(string='HIGH')
+

Virtual machines with this priority have a higher chance of powering on +after a failure if there is insufficient capacity on hosts to meet all +virtual machine needs.

+
+ +
+
+HIGHEST = RestartPriority(string='HIGHEST')
+

Virtual machines with this priority have the highest chance of powering on +after a failure if there is insufficient capacity on hosts to meet all +virtual machine needs.

+
+ +
+
+LOW = RestartPriority(string='LOW')
+

Virtual machines with this priority have a lower chance of powering on +after a failure if there is insufficient capacity on hosts to meet all +virtual machine needs.

+
+ +
+
+LOWEST = RestartPriority(string='LOWEST')
+

Virtual machines with this priority have the lowest chance of powering on +after a failure if there is insufficient capacity on hosts to meet all +virtual machine needs.

+
+ +
+
+MEDIUM = RestartPriority(string='MEDIUM')
+

Virtual machines with this priority have an intermediate chance of powering +on after a failure if there is insufficient capacity on hosts to meet all +virtual machine needs.

+
+ +
+ +
+
+class ServiceState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Possible states of an HA service. All services support the disabled and +enabled states.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ServiceState instance.

+
+
+
+
+DISABLED = ServiceState(string='DISABLED')
+

HA service is disabled.

+
+ +
+
+ENABLED = ServiceState(string='ENABLED')
+

HA service is enabled.

+
+ +
+ +
+
+class StorageVmReaction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The VM policy settings that determine the response to storage failures.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StorageVmReaction instance.

+
+
+
+
+CLUSTER_DEFAULT = StorageVmReaction(string='CLUSTER_DEFAULT')
+

VM will use the cluster default setting. This option is only meaningful for +per-VM settings.

+
+ +
+
+DISABLED = StorageVmReaction(string='DISABLED')
+

VM Component Protection service will not monitor or react to the component +failure. This setting does not affect other vSphere HA services such as +Host Monitoring or VM Health Monitoring.

+
+ +
+
+RESTART_AGGRESSIVE = StorageVmReaction(string='RESTART_AGGRESSIVE')
+

VM Component Protection service protects VMs aggressively. With this +setting, the service will terminate an affected VM even if it can’t +determine that capacity exists to restart the VM.

+
+ +
+
+RESTART_CONSERVATIVE = StorageVmReaction(string='RESTART_CONSERVATIVE')
+

VM Component Protection service protects VMs conservatively. With this +setting, when the service can’t determine that capacity is available to +restart a VM, it will favor keeping the VM running.

+
+ +
+
+WARNING = StorageVmReaction(string='WARNING')
+

VM Component Protection service will monitor component failures but will +not restart an affected VM. Rather it will notify users about the component +failures. This setting does not affect other vSphere HA services such as +Host Monitoring or VM Health Monitoring.

+
+ +
+ +
+
+class VmMonitoringState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The enum defines values that indicate the state of Virtual Machine Health +Monitoring. Health Monitoring uses the vmTools (guest) and application +agent heartbeat modules. You can configure HA to respond to heartbeat +failures of either one or both modules. You can also disable the HA +response to heartbeat failures.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the VmMonitoringState instance.

+
+
+
+
+VM_AND_APP_MONITORING = VmMonitoringState(string='VM_AND_APP_MONITORING')
+

HA response to both guest and application heartbeat failure is enabled.

+
+ +
+
+VM_MONITORING_DISABLED = VmMonitoringState(string='VM_MONITORING_DISABLED')
+

Virtual machine health monitoring is disabled. In this state, HA response +to guest and application heartbeat failures are disabled.

+
+ +
+
+VM_MONITORING_ONLY = VmMonitoringState(string='VM_MONITORING_ONLY')
+

HA response to guest heartbeat failure is enabled.

+
+ +
+ +
+
+class VmReactionOnAPDCleared(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

If an APD condition clears after an APD timeout condition has been declared +and before VM Component Protection service terminated the VM, the guestOS +and application may no longer be operational.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the VmReactionOnAPDCleared instance.

+
+
+
+
+NONE = VmReactionOnAPDCleared(string='NONE')
+

VM Component Protection service will not react after APD condition is +cleared.

+
+ +
+
+RESET = VmReactionOnAPDCleared(string='RESET')
+

VM Component Protection service will reset the VM after APD condition is +cleared. Note this only applies if the subject VM is still powered on.

+
+ +
+
+USE_CLUSTER_DEFAULT = VmReactionOnAPDCleared(string='USE_CLUSTER_DEFAULT')
+

VM will use the cluster default setting. This option is only meaningful for +per-VM settings.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy(cpu=None, memory=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This policy allows setting a fixed slot size

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu (long) – The cpu component of the slot size (in MHz)

    • +

  • memory (long) – The memory component of the slot size (in megabytes)

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides(name=None, vm_restart_priority=None, vm_additional_delay=None, vm_restart_priority_timeout=None, vm_isolation_response=None, vm_datastore_with_pdl_failure_response=None, vm_apd_failure_response=None, vm_apd_failover_delay=None, vm_apd_response_recovery=None, vm_monitoring=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VmOverrides data object contains the HA configuration settings for vm +as a override from cluster. All fields are optional.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Reference to the virtual machine.

    • +

  • vm_restart_priority (FailuresAndResponses.RestartPriority or None) – Restart priority for a virtual machine. +If None or empty, the value is skipped.

    • +

  • vm_additional_delay (long or None) – After condition has been met, a mandatory delay before starting the +next VM restart priority.

    • +

  • vm_restart_priority_timeout (long or None) – This setting is used to specify a maximum time the lower priority +VMs should wait for the higher priority VMs to be ready. If the +higher priority Vms are not ready by this time, then the lower +priority VMs are restarted irrespective of the VM ready state. This +timeout can be used to prevent the failover of lower priority VMs +to be stuck infinitely. +If None or empty, the value is skipped.

    • +

  • vm_isolation_response (FailuresAndResponses.IsolationResponse or None) –

    Indicates whether or not the virtual machine should be powered off +if a host determines that it is isolated from the rest of the +compute resource.

    +

    If not specified at either the cluster level or the virtual machine +level, this will default to powerOff. +If None or empty, the value is skipped.

    +

    • +

  • vm_datastore_with_pdl_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as +Permenant Device Loss (PDL). PDL indicates storage device failure +or LUN removal. In case of PDL, the failed datastore or device is +unlikely to recover. The details of PDL are

    • +

  • vm_apd_failure_response (FailuresAndResponses.StorageVmReaction) – VM storage protection setting for storage failures categorized as +All Paths Down (APD). APD is a condition where a storage has become +inaccessible for unknown reasons. It only indicates loss of +connectivity and does not indicate storage device failure or LUN +removal (Permanent Device Loss or PDL)

    • +

  • vm_apd_failover_delay (long or None) – The time interval after an APD timeout has been declared and before +VM Component Protection service will terminate the VM. The default +value is 180 seconds if not specified. To use cluster setting for a +VM override, set to -1 in per-VM setting.

    • +

  • vm_apd_response_recovery (FailuresAndResponses.VmReactionOnAPDCleared or None) – Action taken by VM Component Protection service for a powered on VM +when APD condition clears after APD timeout. This property is +meaningful only when vSphere HA is turned on. Valid values are

    • +

  • vm_monitoring (FailuresAndResponses.VmMonitoringState or None) – Virtual machine health monitoring is disabled. In this state, HA +response to guest and application heartbeat failures are disabled.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores(heartbeat_datastore_policy=None, datastores=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HeartBeatDataStores class contains attributes describing the +HeartBeatDataStores It contains cluster-wide configurations for vsphere HA.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class HBDatastoreCandidate(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The policy to determine the candidates from which vCenter Server can choose +heartbeat datastores.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HBDatastoreCandidate instance.

+
+
+
+
+ALL_FEASIBLE_DS = HBDatastoreCandidate(string='ALL_FEASIBLE_DS')
+

vCenter Server chooses heartbeat datastores from all the feasible ones, +i.e., the datastores that are accessible to more than one host in the +cluster. The choice will be made without giving preference to those +specified by the user (see #heartbeatDatastore).

+
+ +
+
+ALL_FEASIBLE_DS_WITH_USER_PREFERENCE = HBDatastoreCandidate(string='ALL_FEASIBLE_DS_WITH_USER_PREFERENCE')
+

vCenter Server chooses heartbeat datastores from all the feasible ones +while giving preference to those specified by the user (see +#heartbeatDatastore). More specifically, the datastores not included in +#heartbeatDatastore will be chosen if and only if the specified ones are +not sufficient.

+
+ +
+
+USER_SELECTED_DS = HBDatastoreCandidate(string='USER_SELECTED_DS')
+

vCenter Server chooses heartbeat datastores from the set specified by the +user (see #heartbeatDatastore). More specifically, datastores not included +in the set will not be chosen. Note that if #heartbeatDatastore is empty, +datastore heartbeating will be disabled for HA.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VmToolsMonitoringSettings(enabled=None, cluster_settings=None, failure_interval=None, min_up_time=None, max_failures=None, max_failure_window=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The vim.cluster.VmToolsMonitoringSettings data object contains virtual +machine monitoring settings that are used by the Virtual Machine Health +Monitoring Service. The Service checks the VMware Tools heartbeat of a +virtual machine. If heartbeats have not been received within a specified +time interval, the Service declares the virtual machine as failed and +resets the virtual machine. All fields are optional. In case of a +reconfiguration, fields left unset are not changed.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) –

    Flag indicating whether or not the Virtual Machine Health +Monitoring service is enabled.

    +

    The Server does not use this property.

    +

    • +

  • cluster_settings (bool or None) –

    Flag indicating whether to use the cluster settings or the per VM +settings.

    +

    The default value is true.

    +

    • +

  • failure_interval (long or None) –

    If no heartbeat has been received for at least the specified number +of seconds, the virtual machine is declared as failed.

    +

    The default value is 30.

    +

    • +

  • min_up_time (long or None) –

    The number of seconds for the virtual machine’s heartbeats to +stabilize after the virtual machine has been powered on. This time +should include the guest operating system boot-up time. The virtual +machine monitoring will begin only after this period.

    +

    The default value is 120.

    +

    • +

  • max_failures (long or None) –

    Maximum number of failures and automated resets allowed during the +time that VmToolsMonitoringSettings.max_failure_window +specifies. If VmToolsMonitoringSettings.max_failure_window +is -1 (no window), this represents the absolute number of failures +after which automated response is stopped.

    +

    If a virtual machine exceeds this threshold, in-depth problem +analysis is usually needed.

    +

    The default value is 3.

    +

    • +

  • max_failure_window (long or None) –

    The number of seconds for the window during which up to +VmToolsMonitoringSettings.max_failures resets can occur +before automated responses stop.

    +

    If set to -1, no failure window is specified.

    +

    The default value is -1.

    +

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA(enabled=None, failures_and_responses=None, admission_control=None, heartbeat_datastores=None, advanced_options=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DasInfo class contains attributes describing the HA specific +configurations of a cluster. It contains cluster-wide configurations for +DAS.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – HA Enabled or Disabled Flag to indicate whether or not vSphere HA +feature is enabled.

    • +

  • failures_and_responses (FailuresAndResponses or None) – Configuration settings for HA Failures and responses. +If None or empty, the value is skipped.

    • +

  • admission_control (AdmissionControl or None) – Configuration settings for HA admission control. +If None or empty, the value is skipped.

    • +

  • heartbeat_datastores (HeartBeatDataStores or None) – Configuration settings for heart beat data store policy. +If None or empty, the value is skipped.

    • +

  • advanced_options (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.OptionValue or None) – Advanced settings. +If None or empty, the value is skipped.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo(checksum_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Default VSAN service configuration to be used for hosts admitted to the +cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

checksum_enabled (bool or None) – Whether the VSAN service is configured to enforce checksum +protection. If omitted while enabling the VSAN service, this value +will default to false. Change this value to false shall not +affect any existing disk status. Changing this value to true +shall do disk enforcement check that all VSAN disks are checksum +enabled.````

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo(enabled=None, default_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VsanConfigInfo data object contains configuration data for the +VSAN service in a cluster. This data object is used both for specifying +cluster-wide settings when updating the VSAN service, and as an output +datatype when retrieving current cluster-wide VSAN service settings.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) – Whether the VSAN service is enabled for the cluster.

    • +

  • default_config (HostDefaultInfo or None) – Default VSAN settings to use for hosts admitted to the cluster when +the VSAN service is enabled. If omitted, values will default as +though the fields in the HostDefaultInfo have been +omitted.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html new file mode 100644 index 00000000..848c2f86 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html @@ -0,0 +1,997 @@ + + + + + + + com.vmware.appliance.vcenter.settings.v1.config.components.inventory package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module

+

The +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client +module provides classes to manage the vCenter Server Inventory cluster +configurations

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo(name=None, parent_path=None, ha=None, ha_vm_overrides=None, drs=None, drs_vm_overrides=None, rules=None, groups=None, proactive_ha=None, hosts=None, permissions=None, resource_pools=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterConfigInfo class contains attributes describing the complete +configuration of a cluster. It contains cluster-wide configurations of DRS, +HA VSAN Cluster etc.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client module

+

The +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client +module provides data types to manage the vCenter Server Inventory common +configurations

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.OptionValue(key=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes the key/value pair of a configured option.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (str or None) – The name of the option using dot notation to reflect the option’s +position in a hierarchy. For example, you might have an option +called “Ethernet” and another option that is a child of that called +“Connection”. In this case, the key for the latter could be defined +as “Ethernet.Connection”

    • +

  • value (str or None) – The value of the option. The Any data object type enables you to +define any value for the option. Typically, however, the value of +an option is of type String or Integer.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission(principal=None, group=None, propagate=None, role_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Permission class contains spec to define permissions in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • principal (str) – User/Group name associated with the permission.

    • +

  • group (bool) – True if principal is a group.

    • +

  • propagate (bool) – True if permission can be propagated to child entities.

    • +

  • role_id (long) – Role associated with the permission.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module

+

The {\@name +com.vmware.appliance.vcenter.settings.v1.config.components.inventory +.datacenter} module provides classes to manage the datacenter config.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter(name=None, parent_path=None, permissions=None, standalone_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datacenter class contains spec to define datacenter in vCenter +Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the datacenter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter.

    • +

  • parent_path (str or None) – Absolute path of the inventory object’s parent. +If None, then inventory object placed in root folder.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the datacenter. +If None, then no permissions defined on this inventory object.

    • +

  • standalone_hosts (list of str or None) – Host configuration on the datacenter. +If None, then no hosts present in the datacenter.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module

+

The {\@name +com.vmware.appliance.vcenter.settings.v1.config.components.inventory +.datastore} module provides classes to manage the datastore and storagepod +config.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore(name=None, parent_path=None, summary=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Datastore class defines the spec for datastore configurations in +vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The identifier of the datastore. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore.

    • +

  • parent_path (str) – Absolute path of the inventory object’s parent.

    • +

  • summary (Summary or None) – Summary of the datastore.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the datastore. +If None, then no permissions defined on this inventory object.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The MaintenanceModeState class defines the maintenance mode states of +the datastore.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MaintenanceModeState instance.

+
+
+
+
+ENTERING_MAINTENANCE = MaintenanceModeState(string='ENTERING_MAINTENANCE')
+

Started entering maintenance mode, but not finished. This could happen when +waiting for user input or for long-running vmotions to complete.

+
+ +
+
+IN_MAINTENANCE = MaintenanceModeState(string='IN_MAINTENANCE')
+

Successfully entered maintenance mode.

+
+ +
+
+NORMAL = MaintenanceModeState(string='NORMAL')
+

Default state.

+
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry(storage_drs_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PodStorageDrsEntry class contains spec to define storage DRS related +attributes of the Storage Pod.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

storage_drs_config (StorageDrsConfigInfo) – Storage DRS configuration.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo(pod_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageDrsConfigInfo class contains spec to define storage DRS +configurations.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

pod_config (StorageDrsPodConfigInfo) – Pod-wide configuration information for the storage DRS service.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageDrsConfigInfo class contains spec to define pod-wide +configuration information for the storage DRS service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool) – Flag indicating whether or not storage DRS is enabled.

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod(name=None, parent_path=None, pod_storage_drs_entry=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StoragePod class contains spec to define storage pod in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the Storage Pod. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod.

    • +

  • parent_path (str) – Absolute path of the inventory object’s parent.

    • +

  • pod_storage_drs_entry (PodStorageDrsEntry) – Storage DRS related attributes of the Storage Pod.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the Storage Pod. +If None, then no permissions defined on this inventory object.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary(capacity=None, multiple_host_access=None, type=None, maintenance_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Summary class defines the datastore summary properties.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • capacity (long or None) – Maximum capacity of this datastore, in bytes. This value is updated +periodically by the server. It can be explicitly refreshed with the +Refresh operation.

    • +

  • multiple_host_access (bool or None) – More than one host in the datacenter has been configured with +access to the datastore. This is only provided by VirtualCenter. +If None, then the datastore not configured with access from more +than one host.

    • +

  • type (str or None) – Type of file system volume, such as VMFS or NFS.

    • +

  • maintenance_mode (MaintenanceModeState or None) – The current maintenance mode state of the datastore. +If None, then the current maintenance mode state of the datastore +is set to normal.

    • +
+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module

+

The {\@name +com.vmware.appliance.vcenter.settings.v1.config.components.inventory .folder} +module provides classes to manage the folder config.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder(datastore=None, datacenter=None, vm=None, network=None, host=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Folder class contains spec to define folder in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (list of FolderDetails or None) – List of datastore folders. +If None. then there are no datastore folders.

    • +

  • datacenter (list of FolderDetails or None) – List of datacenter folders. +If None. then there are no datacenter folders.

    • +

  • vm (list of FolderDetails or None) – List of vm folders. +If None. then there are no vm folders.

    • +

  • network (list of FolderDetails or None) – List of network folders. +If None. then there are no network folders.

    • +

  • host (list of FolderDetails or None) – List of host folders. +If None. then there are no host folders.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails(name=None, parent_path=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The FolderDetails class contains spec to define folder in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the vCenter Server folder. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder.

    • +

  • parent_path (str or None) – Absolute path of the inventory object’s parent. +If None, then inventory object placed in root folder.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the folder. +If None, then no permissions defined on this inventory object.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module

+

The {\@name com.vmware.appliance.vcenter.settings.v1.config.components +inventory.host} module provides classes to manage the ConfigManagement.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig(name=None, permissions=None, parent_path=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostConfig class contains attributes describing the configuration +of a Stand alone host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module

+

The {\@name +com.vmware.appliance.vcenter.settings.v1.config.components.inventory .network} +module provides classes to manage the network config.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network(name=None, parent_path=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Network class contains spec to define standard network in vCenter +Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the network. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network.

    • +

  • parent_path (str) – Absolute path of the inventory object’s parent.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the network. +If None, then no permissions defined on this inventory object.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module

+

The {\@name com.vmware.appliance.vcenter.settings.v1.config.components +inventory.resourcepool} module provides classes to manage the ConfigManagement.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourceAllocationInfo(reservation=None, expandable_reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAllocationInfo class contains resource allocation +information of a resource pool.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long) – Amount of resource that is guaranteed available to a resource pool. +Reserved resources are not wasted if they are not used. If the +utilization is less than the reservation, the resources can be +utilized by other running virtual machines. Units are MB fo memory, +and MHz for CPU.

    • +

  • expandable_reservation (bool) – In a resource pool with an expandable reservation, the reservation +can grow beyond the specified value, if the parent resource pool +has unreserved resources. A non-expandable reservation is called a +fixed reservation.

    • +

  • limit (long) – The utilization of a resource pool will not exceed this limit, even +if there are available resources. This is typically used to ensure +a consistent performance of resource pools independent of available +resources. If set to -1, then there is no fixed limit on resource +usage (only bounded by available resources and shares). Units are +MB for memory, and MHz for CPU.

    • +

  • shares (Shares) – Shares are used in case of resource contention.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool(name=None, parent_path=None, child_resource_pools=None, vm=None, config=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool class contains information about resource pools +present in the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the vCenter Server resource pool.

    • +

  • parent_path (str or None) – Parent name for the resource pool. +If None, then inventory object placed in root folder.

    • +

  • child_resource_pools (list of str or None) – Identifiers of the child resource pools contained in this resource +pool. +If None or empty, the value is skipped.

    • +

  • vm (list of str or None) – Identifiers of the virtual machines contained in this resource +pool. +If None or empty, the value is skipped.

    • +

  • config (ResourcePoolSummary) – Summary of the Resource pools.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permission on the resourcepool. +If None, then no permissions defined on this inventory object.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary(cpu_allocation=None, memory_allocation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePoolSummary class provides summary of ResourcePool.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares(level=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Shares class provides specification of shares.

+

Shares are used to determine relative allocation between resource +consumers. In general, a consumer with more shares gets proportionally more +of the resource, subject to certain other constraints.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • level (Shares.Level) – The allocation level. It maps to a pre-determined set of numeric +values for shares. If the shares value does not map to a predefined +size, then the level is set as CUSTOM.

    • +

  • shares (long) –

    When Shares.level is set to CUSTOM, it is the number of +shares allocated. Otherwise, this value is ignored.

    +

    There is no unit for this value. It is a relative measure based on +the settings for other resource pools.

    +

    • +
+
+
+
+
+class Level(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Shares.Level class defines the possible values for the allocation +level.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Level instance.

+
+
+
+
+CUSTOM = Level(string='CUSTOM')
+

If set, in case there is resource contention the server uses the +shares value to determine the resource allocation.

+
+ +
+
+HIGH = Level(string='HIGH')
+

For CPU: Shares = 2000 * nmumber of virtual CPUs. +For Memory: Shares = 20 * virtual machine memory size in MB.

+
+ +
+
+LOW = Level(string='LOW')
+

For CPU: Shares = 500 * number of virtual CPUs. +For Memory: Shares = 5 * virtual machine memory size in MB.

+
+ +
+
+NORMAL = Level(string='NORMAL')
+

For CPU: Shares = 1000 * number of virtual CPUs. +For Memory: Shares = 10 * virtual machine memory size in MB.

+
+ +
+ +
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client module

+

The {\@name com.vmware.appliance.vcenter.settings.v1.config.components +inventory.vm} module provides classes to manage the ConfigManagement.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ConfigInfo(hardware=None, cpu_allocation=None, memory_allocation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConfigInfo class provides configuration of a VirtualMachine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo(reservation=None, limit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAllocationInfo class provides resource allocation of +VirtualMachine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long or None) – Amount of resource that is guaranteed available. Units are MB for +memory, MHz for CPU. +If None, then there is no reservation.

    • +

  • limit (long or None) – The utilization will not exceed this limit, even if there are +available resources. If set to -1, then there is no fixed limit on +resource usage (only bounded by available resources and shares). +Units are MB for memory, MHz for CPU. +If None, then there is no limit.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualHardware(num_cpu=None, memory_mb=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualHardware class provides the virtual hardware configuration +of a VirtualMachine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • num_cpu (long) – Number of virtual CPUs.

    • +

  • memory_mb (long) – Memory size in MB.

    • +
+
+
+
+ +
+
+class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualMachineConfig(name=None, parent_path=None, resource_pool=None, config=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineConfig class contains information about virtual +machine configurations present in the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the vCenter Server virtual machine configuration.

    • +

  • parent_path (str or None) – Parent path for the virtual machine configuration. +If None, then virtual machine placed in root folder.

    • +

  • resource_pool (str or None) – The identifier of current ResourcePool defining the resource +allocation for this virtual machine. +If None, this is a Template VM or current user session has no +access to the resource pool.

    • +

  • config (ConfigInfo or None) – Configuration of the VirtualMachine. +If None, then there is no configuration.

    • +

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the virtual machine. +If None, then no permissions defined on this inventory object.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.html new file mode 100644 index 00000000..a0a22cb0 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.config.html @@ -0,0 +1,198 @@ + + + + + + + com.vmware.appliance.vcenter.settings.v1.config package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.appliance.vcenter.settings.v1.config package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.vcenter.settings.v1.config.components_client module

+

The com.vmware.appliance.vcenter.settings.v1.config.components_client +module provides classes to manage the ConfigManagement.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config.components_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.html b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.html new file mode 100644 index 00000000..2a2a3835 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.appliance.vcenter.settings.v1.html @@ -0,0 +1,205 @@ + + + + + + + com.vmware.appliance.vcenter.settings.v1 package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.appliance.vcenter.settings.v1 package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance.vcenter.settings.v1.config_client module

+

The com.vmware.appliance.vcenter.settings.v1.config_client module provides +classes to manage the ConfigManagement.

+
+
+class com.vmware.appliance.vcenter.settings.v1.config_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.cis.html b/vsphere/8.0.2.0/com.vmware.cis.html new file mode 100644 index 00000000..d07ff863 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.cis.html @@ -0,0 +1,1716 @@ + + + + + + + com.vmware.cis package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.cis package

+
+

Submodules

+
+
+

com.vmware.cis.tagging_client module

+

The com.vmware.cis.tagging_client component provides methods and classes to +attach metadata, by means of tags, to vSphere objects to make these objects +more sortable and searchable. You can use it to create, manage, and enumerate +tags and their categories (the group a tag belongs to). You can also query the +attached tags and attached objects.

+
+
+class com.vmware.cis.tagging_client.Category(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Category class provides methods to create, read, update, delete, +and enumerate categories.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, description=None, cardinality=None, associable_types=None, category_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Category.CreateSpec class is used to create a category.

+

Use the Category.create() method to create a category defined by the +create specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The display name of the category.

    • +

  • description (str) – The description of the category.

    • +

  • cardinality (CategoryModel.Cardinality) – The associated cardinality (SINGLE, MULTIPLE) of the category.

    • +

  • associable_types (set of str) – Object types to which this category’s tags can be attached.

    • +

  • category_id (str or None) – This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Category. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.cis.tagging.Category. +If None an identifier will be generated by the server

    • +
+
+
+
+ +
+
+class UpdateSpec(name=None, description=None, cardinality=None, associable_types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Category.UpdateSpec class describes the updates to be made to an +existing category.

+

Use the Category.update() method to modify a category. When you call +the method, specify the category identifier. You obtain the category +identifier when you call the Category.create() method. You can also +retrieve an identifier by using the Category.list() method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – The display name of the category. +If None the name will not be modified.

    • +

  • description (str or None) – The description of the category. +If None the description will not be modified.

    • +

  • cardinality (CategoryModel.Cardinality or None) – The associated cardinality (SINGLE, MULTIPLE) of the category. +If None the cardinality will not be modified.

    • +

  • associable_types (set of str or None) –

    Object types to which this category’s tags can be attached.

    +

    The set of associable types cannot be updated +incrementally. For example, if +Category.UpdateSpec.associable_types originally contains +{A,B,C} and you want to add D, then you need to pass {A,B,C,D} in +your update specification. You also cannot remove any item from +this set. For example, if you have {A,B,C}, then you +cannot remove say {A} from it. Similarly, if you start with an +empty set, then that implies that you can tag any object +and hence you cannot later pass say {A}, because that would be +restricting the type of objects you want to tag. Thus, associable +types can only grow and not shrink. +If None the associable types will not be modified.

    +

    • +
+
+
+
+ +
+
+add_to_used_by(category_id, used_by_entity)
+

Adds the used_by_entity to the CategoryModel.used_by +subscribers set for the specified category. If the +used_by_entity is already in the set, then this becomes an +idempotent no-op. To invoke this method, you need the modify +CategoryModel.used_by privilege on the category.

+
+
Parameters
+
    +

  • category_id (str) – The identifier of the input category. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

    • +

  • used_by_entity (str) – The name of the user to be added to the +CategoryModel.used_by set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to add an entity to the +CategoryModel.used_by field.

+
+
+
+ +
+
+create(create_spec)
+

Creates a category. To invoke this method, you need the create category +privilege.

+
+
Parameters
+

create_spec (Category.CreateSpec) – Specification for the new category to be created.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the created category. +The return value will be an identifier for the resource type: +com.vmware.cis.tagging.Category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the Category.CreateSpec.name provided in the +create_spec is the name of an already existing category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the information in the create_spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to create a category.

+
+
+
+ +
+
+delete(category_id)
+

Deletes an existing category. To invoke this method, you need the +delete privilege on the category.

+
+
Parameters
+

category_id (str) – The identifier of category to be deleted. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to delete the category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+get(category_id)
+

Fetches the category information for the given category identifier. In +order to view the category information, you need the read privilege on +the category.

+
+
Parameters
+

category_id (str) – The identifier of the input category. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

+
+
Return type
+

CategoryModel

+
+
Returns
+

The CategoryModel that corresponds to category_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the category.

+
+
+
+ +
+
+list()
+

Enumerates the categories in the system. To invoke this method, you +need the read privilege on the individual categories. The list +will only contain those categories for which you have read privileges.

+
+
Return type
+

list of str

+
+
Returns
+

The list of resource identifiers for the categories in the +system. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Category.

+
+
+
+ +
+
+list_used_categories(used_by_entity)
+

Enumerates all categories for which the used_by_entity is part of +the CategoryModel.used_by subscribers set. To invoke +this method, you need the read privilege on the individual categories.

+
+
Parameters
+

used_by_entity (str) – The field on which the results will be filtered.

+
+
Return type
+

list of str

+
+
Returns
+

The list of resource identifiers for the categories in the +system that are used by used_by_entity. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Category.

+
+
+
+ +
+
+remove_from_used_by(category_id, used_by_entity)
+

Removes the used_by_entity from the CategoryModel.used_by +subscribers set. If the used_by_entity is not using this +category, then this becomes a no-op. To invoke this method, you need +the modify CategoryModel.used_by privilege on the category.

+
+
Parameters
+
    +

  • category_id (str) – The identifier of the input category. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

    • +

  • used_by_entity (str) – The name of the user to be removed from the +CategoryModel.used_by set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to remove an entity from the +CategoryModel.used_by field.

+
+
+
+ +
+
+revoke_propagating_permissions(category_id)
+

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 +(direct or propagating) on the concerned category.

+
+
Parameters
+

category_id (str) – The identifier of the input category. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to revoke propagating permissions +on the category.

+
+
+
+ +
+
+update(category_id, update_spec)
+

Updates an existing category. To invoke this method, you need the edit +privilege on the category.

+
+
Parameters
+
    +

  • category_id (str) – The identifier of the category to be updated. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

    • +

  • update_spec (Category.UpdateSpec) – Specification to update the category.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the Category.UpdateSpec.name provided in the +update_spec is the name of an already existing category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the information in the update_spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to update the category.

+
+
+
+ +
+ +
+
+class com.vmware.cis.tagging_client.CategoryModel(id=None, name=None, description=None, cardinality=None, associable_types=None, used_by=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CategoryModel class defines a category that is used to group one or +more tags.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The unique identifier of the category. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Category. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.cis.tagging.Category.

    • +

  • name (str) – The display name of the category.

    • +

  • description (str) – The description of the category.

    • +

  • cardinality (CategoryModel.Cardinality) – The associated cardinality (SINGLE, MULTIPLE) of the category.

    • +

  • associable_types (set of str) – The types of objects that the tags in this category can be attached +to. If the set is empty, then tags can be attached to all +types of objects. This field works only for objects that reside in +Inventory Service (IS). For non IS objects, this check is not +performed today and hence a tag can be attached to any non IS +object.

    • +

  • used_by (set of str) – The set of users that can use this category. To add users +to this, you need to have the edit privilege on the category. +Similarly, to unsubscribe from this category, you need the edit +privilege on the category. You should not modify other users +subscription from this set.

    • +
+
+
+
+
+class Cardinality(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CategoryModel.Cardinality class defines the number of tags in a +category that can be assigned to an object.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Cardinality instance.

+
+
+
+
+MULTIPLE = Cardinality(string='MULTIPLE')
+

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 +can be assigned more than one of the above tags and hence the cardinality +of the associated category here is multiple.

+
+ +
+
+SINGLE = Cardinality(string='SINGLE')
+

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 +can be assigned only one of these tags and hence the cardinality of the +associated category here is single.

+
+ +
+ +
+ +
+
+class com.vmware.cis.tagging_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.cis.tagging_client.Tag(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Tag class provides methods to create, read, update, delete, and +enumerate tags.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, description=None, category_id=None, tag_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tag.CreateSpec class describes a tag.

+

Use the Tag.create() method to create a tag defined by the create +specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The display name of the tag. The name must be unique within its +category.

    • +

  • description (str) – The description of the tag.

    • +

  • category_id (str) – The unique identifier of the parent category in which this tag will +be created. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Category. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.cis.tagging.Category.

    • +

  • tag_id (str or None) – This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.cis.tagging.Tag. +If None an identifier will be generated by the server

    • +
+
+
+
+ +
+
+class UpdateSpec(name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tag.UpdateSpec class describes the updates to be made to an +existing tag.

+

Use the Tag.update() method to modify a tag. When you call the +method, you specify the tag identifier. You obtain the tag identifier when +you call the Tag.create() method. You can also retrieve an identifier +by using the Tag.list() method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – The display name of the tag. +If None the name will not be modified.

    • +

  • description (str or None) – The description of the tag. +If None the description will not be modified.

    • +
+
+
+
+ +
+
+add_to_used_by(tag_id, used_by_entity)
+

Adds the used_by_entity to the TagModel.used_by subscribers +set. If the used_by_entity is already in the set, +then this becomes a no-op. To invoke this method, you need the modify +TagModel.used_by privilege on the tag.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • used_by_entity (str) – The name of the user to be added to the TagModel.used_by +set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to add an entity to the +TagModel.used_by field.

+
+
+
+ +
+
+create(create_spec)
+

Creates a tag. To invoke this method, you need the create tag privilege +on the input category.

+
+
Parameters
+

create_spec (Tag.CreateSpec) – Specification for the new tag to be created.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the created tag. +The return value will be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the Tag.CreateSpec.name provided in the create_spec +is the name of an already existing tag in the input category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the input information in the create_spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for in the given create_spec does not exist in +the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to create tag.

+
+
+
+ +
+
+delete(tag_id)
+

Deletes an existing tag. To invoke this method, you need the delete +privilege on the tag.

+
+
Parameters
+

tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to delete the tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+get(tag_id)
+

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.

+
+
Parameters
+

tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Return type
+

TagModel

+
+
Returns
+

The TagModel that corresponds to tag_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the privilege to read the tag.

+
+
+
+ +
+
+list()
+

Enumerates the tags in the system. To invoke this method, you need read +privilege on the individual tags. The list will only contain +tags for which you have read privileges.

+
+
Return type
+

list of str

+
+
Returns
+

The list of resource identifiers for the tags in the +system. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

+
+
+
+ +
+
+list_tags_for_category(category_id)
+

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.

+
+
Parameters
+

category_id (str) – The identifier of the input category. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Category.

+
+
Return type
+

list of str

+
+
Returns
+

The list of resource identifiers for the tags in the given +input category. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the category for the given category_id does not exist in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the category.

+
+
+
+ +
+
+list_used_tags(used_by_entity)
+

Enumerates all tags for which the used_by_entity is part of the +TagModel.used_by subscribers set. To invoke this +method, you need the read privilege on the individual tags.

+
+
Parameters
+

used_by_entity (str) – The field on which the results will be filtered.

+
+
Return type
+

list of str

+
+
Returns
+

The list of resource identifiers for the tags in the +system that are used by used_by_entity. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

+
+
+
+ +
+
+remove_from_used_by(tag_id, used_by_entity)
+

Removes the used_by_entity from the TagModel.used_by +subscribers set. If the used_by_entity is not using this tag, then +this becomes a no-op. To invoke this method, you need modify +TagModel.used_by privilege on the tag.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • used_by_entity (str) – The name of the user to be removed from the +TagModel.used_by set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to remove an entity from the +TagModel.used_by field.

+
+
+
+ +
+
+revoke_propagating_permissions(tag_id)
+

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 +propagating) on the concerned tag.

+
+
Parameters
+

tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to revoke propagating permissions +on the tag.

+
+
+
+ +
+
+update(tag_id, update_spec)
+

Updates an existing tag. To invoke this method, you need the edit +privilege on the tag.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • update_spec (Tag.UpdateSpec) – Specification to update the tag.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the Tag.UpdateSpec.name provided in the update_spec +is the name of an already existing tag in the same category.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the input information in the update_spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to update the tag.

+
+
+
+ +
+ +
+
+class com.vmware.cis.tagging_client.TagAssociation(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TagAssociation class provides methods to attach, detach, and query +tags.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BatchResult(success=None, error_messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TagAssociation.BatchResult class describes the result of performing +the same method on several tags or objects in a single invocation. This +class was added in vSphere API 6.5.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • success (bool) – This is true if the batch method completed without any errors. +Otherwise it is false and all or some methods have failed. This +attribute was added in vSphere API 6.5.

    • +

  • error_messages (list of com.vmware.vapi.std_client.LocalizableMessage) – The list of error messages. This attribute was added in +vSphere API 6.5.

    • +
+
+
+
+ +
+
+class ObjectToTags(object_id=None, tag_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TagAssociation.ObjectToTags class describes an object and its +related tags. Use the TagAssociation.list_attached_tags_on_objects() +method to retrieve a list with each element containing an object +and the tags attached to it. This class was added in vSphere API 6.5.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the object. This attribute was added in vSphere +API 6.5.

    • +

  • tag_ids (list of str) – The identifiers of the related tags. This attribute was added in +vSphere API 6.5. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.cis.tagging.Tag. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.cis.tagging.Tag.

    • +
+
+
+
+ +
+
+class TagToObjects(tag_id=None, object_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TagAssociation.TagToObjects class describes a tag and its related +objects. Use the TagAssociation.list_attached_objects_on_tags() +method to retrieve a list with each element containing a tag and +the objects to which it is attached. This class was added in vSphere API +6.5.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the tag. This attribute was added in vSphere API +6.5. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.cis.tagging.Tag.

    • +

  • object_ids (list of com.vmware.vapi.std_client.DynamicID) – The identifiers of the related objects. This attribute was added in +vSphere API 6.5.

    • +
+
+
+
+ +
+
+attach(tag_id, object_id)
+

Attaches the given tag to the input object. The tag needs to meet the +cardinality (CategoryModel.cardinality) and associability +(CategoryModel.associable_types) criteria in order to be +eligible for attachment. If the tag is already attached to 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 tag and the read +privilege on the object.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the input object.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the input tag is not eligible to be attached to this object or +if the object_id is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to attach the tag or do not have +the privilege to read the object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+attach_multiple_tags_to_object(object_id, tag_ids)
+

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 +TagAssociation.BatchResult.error_messages. To invoke this +method, you need the read privilege on the object and the attach tag +privilege on each tag. This method was added in vSphere API 6.5.

+
+
Parameters
+
    +

  • object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the input object.

    • +

  • tag_ids (list of str) – The identifiers of the input tags. +The parameter must contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

    • +
+
+
Return type
+

TagAssociation.BatchResult

+
+
Returns
+

The outcome of the batch method and the list of error +messages (TagAssociation.BatchResult.error_messages) +describing attachment failures.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+attach_tag_to_multiple_objects(tag_id, object_ids)
+

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 +TagAssociation.BatchResult.error_messages. To invoke this +method, you need the attach tag privilege on the tag and the read +privilege on each object. This method was added in vSphere API 6.5.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • object_ids (list of com.vmware.vapi.std_client.DynamicID) – The identifiers of the input objects.

    • +
+
+
Return type
+

TagAssociation.BatchResult

+
+
Returns
+

The outcome of the batch method and the list of error +messages (TagAssociation.BatchResult.error_messages) +describing attachment failures.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the attach tag privilege on the tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+detach(tag_id, object_id)
+

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 +tag and the read privilege on the object.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the input object.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to detach the tag or do not have +the privilege to read the given object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+detach_multiple_tags_from_object(object_id, tag_ids)
+

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 +TagAssociation.BatchResult.error_messages. To invoke this +method, you need the read privilege on the object and the attach tag +privilege each tag. This method was added in vSphere API 6.5.

+
+
Parameters
+
    +

  • object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the input object.

    • +

  • tag_ids (list of str) – The identifiers of the input tags. +The parameter must contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

    • +
+
+
Return type
+

TagAssociation.BatchResult

+
+
Returns
+

The outcome of the batch method and the list of error +messages (TagAssociation.BatchResult.error_messages) +describing detachment failures.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+detach_tag_from_multiple_objects(tag_id, object_ids)
+

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 +TagAssociation.BatchResult.error_messages. To invoke this +method, you need the attach tag privilege on the tag and the read +privilege on each object. This method was added in vSphere API 6.5.

+
+
Parameters
+
    +

  • tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

    • +

  • object_ids (list of com.vmware.vapi.std_client.DynamicID) – The identifiers of the input objects.

    • +
+
+
Return type
+

TagAssociation.BatchResult

+
+
Returns
+

The outcome of the batch method and the list of error +messages (TagAssociation.BatchResult.error_messages) +describing detachment failures.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the attach tag privilege on the tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+list_attachable_tags(object_id)
+

Fetches the list of attachable tags for the given object, +omitting the tags that have already been attached. Criteria for +attachability is calculated based on tagging cardinality +(CategoryModel.cardinality) and associability +(CategoryModel.associable_types) constructs. To invoke this +method, you need the read privilege on the input object. The +list will only contain those tags for which you have read +privileges.

+
+
Parameters
+

object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the input object.

+
+
Return type
+

list of str

+
+
Returns
+

The list of tag identifiers that are eligible to be +attached to the given object. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+list_attached_objects(tag_id)
+

Fetches the list 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.

+
+
Parameters
+

tag_id (str) – The identifier of the input tag. +The parameter must be an identifier for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Return type
+

list of com.vmware.vapi.std_client.DynamicID

+
+
Returns
+

The list of attached object identifiers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the tag for the given tag_id does not exist in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+list_attached_objects_on_tags(tag_ids)
+

Fetches the list of TagAssociation.TagToObjects +describing the input tag identifiers and the objects they are attached +to. To invoke this method, you need the read privilege on each input +tag. The TagAssociation.TagToObjects.object_ids will only +contain those objects for which you have the read privilege. This +method was added in vSphere API 6.5.

+
+
Parameters
+

tag_ids (list of str) – The identifiers of the input tags. +The parameter must contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Return type
+

list of TagAssociation.TagToObjects

+
+
Returns
+

The list of the tag identifiers to all object identifiers +that each tag is attached to.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+list_attached_tags(object_id)
+

Fetches the list of tags attached to the given object. To +invoke this method, you need the read privilege on the input object. +The list will only contain those tags for which you have the +read privileges.

+
+
Parameters
+

object_id (com.vmware.vapi.std_client.DynamicID) – The identifier of the input object.

+
+
Return type
+

list of str

+
+
Returns
+

The list of all tag identifiers that correspond to the +tags attached to the given object. +The return value will contain identifiers for the resource type: +com.vmware.cis.tagging.Tag.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have the privilege to read the object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+list_attached_tags_on_objects(object_ids)
+

Fetches the list of TagAssociation.ObjectToTags +describing the input object identifiers and the tags attached to each +object. To invoke this method, you need the read privilege on each +input object. The TagAssociation.ObjectToTags.tag_ids will only +contain those tags for which you have the read privilege. This method +was added in vSphere API 6.5.

+
+
Parameters
+

object_ids (list of com.vmware.vapi.std_client.DynamicID) – The identifiers of the input objects.

+
+
Return type
+

list of TagAssociation.ObjectToTags

+
+
Returns
+

The list of the object identifiers to all tag identifiers +that are attached to that object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.cis.tagging_client.TagModel(id=None, category_id=None, name=None, description=None, used_by=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TagModel class defines a tag that can be attached to vSphere +objects.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The unique identifier of the tag. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.cis.tagging.Tag.

    • +

  • category_id (str) – The identifier of the parent category in which this tag will be +created. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Category. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.cis.tagging.Category.

    • +

  • name (str) – The display name of the tag.

    • +

  • description (str) – The description of the tag.

    • +

  • used_by (set of str) – The set of users that can use this tag. To add users to +this, you need to have the edit privilege on the tag. Similarly, to +unsubscribe from this tag, you need the edit privilege on the tag. +You should not modify other users subscription from this +set.

    • +
+
+
+
+ +
+
+

com.vmware.cis.task_client module

+

The com.vmware.cis.task_client module provides classes and classes used for +managing tasks.

+
+
+class com.vmware.cis.task_client.CommonInfo(description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CommonInfo class contains information common to all tasks. This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task. This +attribute was added in vSphere API 6.7.

    • +

  • service (str) – Identifier of the service containing the operation. This attribute +was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. This +attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. This attribute was added in vSphere API +6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. This attribute was added in vSphere +API 6.7. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (Status) – Status of the operation associated with the task. This attribute +was added in vSphere API 6.7.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses. This attribute was +added in vSphere API 6.7.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. This +attribute was added in vSphere API 6.7. +If None the description of why the operation failed will be +included in the result of the operation (see Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of status is one of Status.RUNNING, +Status.BLOCKED, Status.SUCCEEDED, or +Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of status is one of Status.SUCCEEDED or +Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. This attribute was +added in vSphere API 6.7. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+class com.vmware.cis.task_client.Info(progress=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a task. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (Progress) – Progress of the operation. This attribute was added in vSphere API +6.7. +This attribute is optional and it is only relevant when the value +of status is one of Status.RUNNING, +Status.BLOCKED, Status.SUCCEEDED, or +Status.FAILED.

    • +

  • result (DataValue or None) –

    Result of the operation.

    +

    If an operation reports partial results before it completes, this +attribute could be set before the +CommonInfo.status has the value Status.SUCCEEDED. +The value could change as the operation progresses.. This attribute +was added in vSphere API 6.7. +This attribute will be None if the operation does not return a +result or if the result is not available at the current step of the +operation.

    +

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task. This +attribute was added in vSphere API 6.7.

    • +

  • service (str) – Identifier of the service containing the operation. This attribute +was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. This +attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. This attribute was added in vSphere API +6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. This attribute was added in vSphere +API 6.7. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (Status) – Status of the operation associated with the task. This attribute +was added in vSphere API 6.7.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses. This attribute was +added in vSphere API 6.7.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. This +attribute was added in vSphere API 6.7. +If None the description of why the operation failed will be +included in the result of the operation (see Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of status is one of Status.RUNNING, +Status.BLOCKED, Status.SUCCEEDED, or +Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. This attribute was added in +vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of status is one of Status.SUCCEEDED or +Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. This attribute was +added in vSphere API 6.7. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+class com.vmware.cis.task_client.Progress(total=None, completed=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Progress class contains information describe the progress of an +operation. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • total (long) – Total amount of the work for the operation. This attribute was +added in vSphere API 6.7.

    • +

  • completed (long) – The amount of work completed for the operation. The value can only +be incremented. This attribute was added in vSphere API 6.7.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – Message about the work progress. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+class com.vmware.cis.task_client.Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Status class defines the status values that can be reported for an +operation. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+BLOCKED = Status(string='BLOCKED')
+

The operation is blocked. This class attribute was added in vSphere API +6.7.

+
+ +
+
+FAILED = Status(string='FAILED')
+

The operation failed. This class attribute was added in vSphere API 6.7.

+
+ +
+
+PENDING = Status(string='PENDING')
+

The operation is in pending state. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The operation is in progress. This class attribute was added in vSphere API +6.7.

+
+ +
+
+SUCCEEDED = Status(string='SUCCEEDED')
+

The operation completed successfully. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+class com.vmware.cis.task_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.content.html b/vsphere/8.0.2.0/com.vmware.content.html new file mode 100644 index 00000000..d78a8f3d --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.content.html @@ -0,0 +1,2485 @@ + + + + + + + com.vmware.content package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.content package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.content.library_client module

+

The Content Library module provides classes and classes for defining and +managing the library’s items, subscription, publication, and storage.

+
+
+class com.vmware.content.library_client.Item(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Item class provides methods for managing library items.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DestinationSpec(subscription=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Item.DestinationSpec class contains information required to publish +the library item to a specific subscription. This class was added in +vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

subscription (str) – Identifier of the subscription associated with the subscribed +library. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Subscriptions. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.Subscriptions.

+
+
+
+ +
+
+class FindSpec(name=None, library_id=None, source_id=None, type=None, cached=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Item.FindSpec class specifies the properties that can be used as a +filter to find library items. When multiple attributes are specified, all +properties of the item must match the specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – The name of the library item. The name is case-insensitive. See +ItemModel.name. +If not specified all library item names are searched.

    • +

  • library_id (str or None) – The identifier of the library containing the item. See +ItemModel.library_id. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +If not specified all libraries are searched.

    • +

  • source_id (str or None) – The identifier of the library item as reported by the publisher. +See ItemModel.source_id. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +If not specified all library items are searched.

    • +

  • type (str or None) – The type of the library item. The type is case-insensitive. See +ItemModel.type. +If not specified all types are searched.

    • +

  • cached (bool or None) – Whether the item is cached. Possible values are ‘true’ or ‘false’. +See ItemModel.cached. +If not specified all library items are searched.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.library.Item'
+

Resource type for item.

+
+ +
+
+copy(source_library_item_id, destination_create_spec, client_token=None)
+

Copies a library item.

+

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 +item, whose identifier is returned. The content of the library item is +then copied asynchronously. This copy can be tracked as a task.

+

If the copy fails, Content Library Service will roll back the copy by +deleting any content that was already copied, and removing the new +library item. A failure during rollback may require manual cleanup by +an administrator.

+

A library item cannot be copied into a subscribed library.

+
+
Parameters
+
    +

  • client_token (str or None) – A unique token generated on the client for each copy request. The +token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent copy. +If not specified copy is not idempotent.

    • +

  • source_library_item_id (str) – Identifier of the existing library item from which the content will +be copied. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • destination_create_spec (ItemModel) – Specification for the new library item to be created.

    • +
+
+
Return type
+

str

+
+
Returns
+

The identifier of the new library item into which the content is +being copied. +The return value will be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item with source_library_item_id does not exist, +or if the library referenced by the ItemModel.library_id +property of destination_create_spec does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the following is true for the new library item:

+
    +

  • name is empty

    • +

  • name exceeds 80 characters

    • +

  • description exceeds 2000 characters

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the client_token does not conform to the UUID format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the ItemModel.library_id property of +destination_create_spec refers to a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the copy operation failed because the source or destination +library item is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the content of the source library item specified by +source_library_item_id, or the content of the target library +specified by the library ID (see ItemModel.library_id) +property of destination_create_spec has been deleted from the +storage backings (see LibraryModel#storageBackings) associated with +it.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter source_library_item_id requires System.Read.

    • +

  • The resource com.vmware.content.Library referenced by the +attribute ItemModel.library_id requires +ContentLibrary.AddLibraryItem.

    • +
+
+
+
+ +
+
+create(create_spec, client_token=None)
+

Creates a new library item.

+

A new library item is created without any content. After creation, +content can be added through the +com.vmware.content.library.item_client.UpdateSession and +com.vmware.content.library.item.updatesession_client.File +classes.

+

A library item cannot be created in a subscribed library.

+
+
Parameters
+
    +

  • client_token (str or None) – A unique token generated on the client for each creation request. +The token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified creation is not idempotent.

    • +

  • create_spec (ItemModel) – Specification that defines the properties of the new library item.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the new library item. +The return value will be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the ItemModel.library_id property of create_spec +refers to a library that does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the following is true for the new library item:

+
    +

  • name is empty

    • +

  • name exceeds 80 characters

    • +

  • description exceeds 2000 characters

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the client_token does not conform to the UUID format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the ItemModel.library_id property of create_spec +refers to a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the content of the library specified by the library ID (see +ItemModel.library_id) property of create_spec has been +deleted from the storage backings (see +LibraryModel#storageBackings) associated with it.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if there is already a library item with same name in the library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +attribute ItemModel.library_id requires +ContentLibrary.AddLibraryItem.

    • +
+
+
+
+ +
+
+delete(library_item_id)
+

Deletes a library item.

+

This method will immediately remove the item from the library that owns +it. The content of the item will be asynchronously removed from the +storage backings. The content deletion can be tracked with a task. In +the event that the task fails, an administrator may need to manually +remove the files from the storage backing.

+

This method cannot be used to delete a library item that is a member of +a subscribed library. Removing an item from a subscribed library +requires deleting the item from the original published local library +and syncing the subscribed library.

+
+
Parameters
+

library_item_id (str) – Identifier of the library item to delete. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library item with the given library_item_id is a member +of a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item with the specified library_item_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the library item contains a virtual machine template and a +virtual machine is checked out of the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.DeleteLibraryItem.

    • +
+
+
+
+ +
+
+find(spec)
+

Returns identifiers of all the visible (as determined by authorization +policy) library items matching the requested Item.FindSpec.

+
+
Parameters
+

spec (Item.FindSpec) – Specification describing what properties to filter on.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of all the visible library items +matching the given spec. +The return value will contain identifiers for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if no properties are specified in the spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.Library referenced by the +attribute Item.FindSpec.library_id requires +System.Read.

    • +
+
+
+
+ +
+
+get(library_item_id)
+

Returns the ItemModel with the given identifier.

+
+
Parameters
+

library_item_id (str) – Identifier of the library item to return. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

ItemModel

+
+
Returns
+

The ItemModel instance with the given library_item_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no item with the given library_item_id exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires System.Read.

    • +
+
+
+
+ +
+
+list(library_id)
+

Returns the identifiers of all items in the given library.

+
+
Parameters
+

library_id (str) – Identifier of the library whose items should be returned. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of the items in the library +specified by library_id. +The return value will contain identifiers for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library associated with library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires System.Read.

    • +
+
+
+
+ +
+
+publish(library_item_id, force_sync_content, subscriptions=None)
+

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 +6.7.2.

+
+
Parameters
+
    +

  • library_item_id (str) – Library item identifier. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • force_sync_content (bool) – Whether to synchronize file content as well as metadata. This +parameter applies only if the subscription is on-demand.

    • +

  • subscriptions (list of Item.DestinationSpec or None) – The list of subscriptions to publish this library item to.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library item specified by library_item_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If one or more arguments in subscriptions is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library item specified by library_item_id is a member of +a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library item specified by library_item_id does not +belong to a published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.PublishLibraryItem.

    • +
+
+
+
+ +
+
+update(library_item_id, update_spec)
+

Updates the specified properties of a library item.

+

This is an incremental update to the library item. Attributes that are +None in the update specification are left unchanged.

+

This method cannot update a library item that is a member of a +subscribed library. Those items must be updated in the source published +library and synchronized to the subscribed library.

+
+
Parameters
+
    +

  • library_item_id (str) – Identifier of the library item to update. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • update_spec (ItemModel) – Specification of the properties to set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by library_item_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library item corresponding to library_item_id is a +member of a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the following is true for the update_spec:

+
    +

  • name is empty

    • +

  • name exceeds 80 characters

    • +

  • description exceeds 2000 characters

    • +

  • version is not equal to the current version of the library item

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the library item belongs to a published library with JSON +persistence enabled (see PublishInfo.persist_json_enabled) +and the content of the library item specified by +library_item_id has been deleted from the storage backings (see +LibraryModel#storageBackings) associated with it.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if there is already a library item with same name in the library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.UpdateLibraryItem.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library_client.ItemModel(id=None, library_id=None, content_version=None, creation_time=None, description=None, last_modified_time=None, last_sync_time=None, metadata_version=None, name=None, cached=None, size=None, type=None, version=None, source_id=None, security_compliance=None, certificate_verification_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ItemModel class represents a library item that has been stored in a +library.

+

A ItemModel represents a single logical unit to be managed within a +com.vmware.content_client.LibraryModel. Items contain the actual +content of a library, and their placement within a library determines +policies that affect that content such as publishing.

+

A library item can have a specified type, indicated with the +ItemModel.type attribute. This property is associated with a +Content Library Service plugin that supports specific types and provides +additional services. The types available in a specific Content Library +Service can be queried using the com.vmware.content_client.Type +class. Items of an unknown or unspecified type are treated generically. +Because subscribed library catalogs are synchronized as is, subscribing to +a remote Content Library Service effectively gives you a library with the +functionality of the remote service’s type adapter plugins, even if they +are not installed locally.

+

Items can be managed using the Item class and, for items in +subscribed libraries, the SubscribedItem class.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – A unique identifier for this library item. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +This attribute is not used for the create method. It will not +be present in the return value of the get or list methods. +It is not used for the update method.

    • +

  • library_id (str) – The identifier of the +com.vmware.content_client.LibraryModel to which this item +belongs. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • content_version (str) – The latest version of the file content list of this library item. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.item.Version. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.item.Version. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • creation_time (datetime.datetime) – The date and time when this library item was created. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • description (str) – A human-readable description for this library item. +This attribute is optional for the create method. Leaving it +None during creation will result in an empty string value. It will +always be present in the result of a get or list method. It +is optional for the update method. Leaving it None during +update indicates that the description remains unchanged.

    • +

  • last_modified_time (datetime.datetime) –

    The date and time when the metadata for this library item was last +changed.

    +

    This attribute is affected by changes to the properties or file +content of this item. It is not modified by changes to the tags of +the item, or by changes to the library which owns this item. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    +

    • +

  • last_sync_time (datetime.datetime) –

    The date and time when this library item was last synchronized.

    +

    This attribute is updated every time a synchronization is triggered +on the library item, including when a synchronization is triggered +on the library to which this item belongs. The value is None for a +library item that belongs to a local library. +This attribute is not used for the create method. It is +optional in the return value of the get or list methods. It +is not used for the update method.

    +

    • +

  • metadata_version (str) –

    A version number for the metadata of this library item.

    +

    This value is incremented with each change to the metadata of this +item. Changes to name, description, and so on will increment this +value. The value is not incremented by changes to the content or +tags of the item or the library which owns it. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    +

    • +

  • name (str) –

    A human-readable name for this library item.

    +

    The name may not be None or an empty string. The name does not have +to be unique, even within the same library. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    +

    • +

  • cached (bool) – The status that indicates whether the library item is on disk or +not. The library item is cached when all its files are on disk. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • size (long) – The library item size, in bytes. The size is the sum of the size +used on the storage backing for all the files in the item. When the +library item is not cached, the size is 0. +This attribute is not used for the create method. It is +optional in the return value of the get or list methods. It +is not used for the update method.

    • +

  • type (str) –

    An optional type identifier which indicates the type adapter plugin +to use.

    +

    This attribute may be set to a non-empty string value that +corresponds to an identifier supported by a type adapter plugin +present in the Content Library Service. A type adapter plugin, if +present for the specified type, can provide additional information +and services around the item content. A type adapter can guide the +upload process by creating file entries that are in need of being +uploaded to complete an item.

    +

    The types and plugins supported by the Content Library Service can +be queried using the com.vmware.content_client.Type class. +This attribute is optional for the create and update +methods. During creation, if the type is left unspecified, or if +the type is specified but does not have a corresponding type +support plugin, then the type of the library item is considered to +be generic and all data is treated as generic files. During update, +if the type is not specified, then it is not updated.

    +

    • +

  • version (str) –

    A version number that is updated on metadata changes. This value is +used to validate update requests to provide optimistic concurrency +of changes.

    +

    This value represents a number that is incremented every time +library item properties, such as name or description, are changed. +It is not incremented by changes to the file content of the library +item, including adding or removing files. It is also not affected +by tagging the library item. +This attribute is not used for the create method. It will +always be present in the result of a get or list method. It +is optional for the update method. Leaving it None during +update indicates that you do not need to detect concurrent updates.

    +

    • +

  • source_id (str) – The identifier of the ItemModel to which this item is +synchronized to if the item belongs to a subscribed library. The +value is None for a library item that belongs to a local library. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +This attribute is not used for the create method. It is +optional in the return value of the get or list methods. It +is not used for the update method.

    • +

  • security_compliance (bool) – Shows the security compliance of ItemModel. This attribute +was added in vSphere API 7.0.3.0. +This attribute is not used for the create and update +methods. It will be present in the result of a get or list +method.

    • +

  • certificate_verification_info (com.vmware.content.library.item_client.CertificateVerificationInfo or None) – Certificate verification status and ItemModel’s signing +certificate . Currently, this field is available only in following +cases 1. This item belongs to a secure content library 2. The item +is of type ovf. This attribute was added in vSphere API 7.0.3.0. +This attribute is not used for the create and update +methods. It may be present in the result of a get or list +method.

    • +
+
+
+
+ +
+
+class com.vmware.content.library_client.OptimizationInfo(optimize_remote_publishing=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OptimizationInfo class defines different optimizations and +optimization parameters applied to particular library.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

optimize_remote_publishing (bool) –

If set to true then library would be optimized for remote +publishing.

+

Turn it on if remote publishing is dominant use case for this +library. Remote publishing means here that publisher and +subscribers are not the part of the same Vcenter SSO domain.

+

Any optimizations could be done as result of turning on this +optimization during library creation. For example, library content +could be stored in different format but optimizations are not +limited to just storage format.

+

Note, that value of this toggle could be set only during creation +of the library and you would need to migrate your library in case +you need to change this value (optimize the library for different +use case). +This attribute is optional for the create method. If not +specified for the create, the default is for the library to not +be optmized for specific use case. It is not used for the +update method.

+

+
+
+
+ +
+
+class com.vmware.content.library_client.PublishInfo(authentication_method=None, published=None, publish_url=None, user_name=None, password=None, current_password=None, persist_json_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PublishInfo class defines how a local library is published publicly +for synchronization to other libraries.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class AuthenticationMethod(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The PublishInfo.AuthenticationMethod class indicates how a subscribed +library should authenticate to the published library endpoint.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the AuthenticationMethod instance.

+
+
+
+
+BASIC = AuthenticationMethod(string='BASIC')
+

Require HTTP Basic authentication matching a specified username and +password.

+
+ +
+
+NONE = AuthenticationMethod(string='NONE')
+

Require no authentication.

+
+ +
+ +
+ +
+
+class com.vmware.content.library_client.SourceInfo(source_library=None, subscription=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SourceInfo class contains information about the source published +library of a subscribed library. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source_library (str) – Identifier of the published library. This attribute was added in +vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +

  • subscription (str) – Identifier of the subscription associated with the subscribed +library. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Subscriptions. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.Subscriptions. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +
+
+
+
+ +
+
+class com.vmware.content.library_client.StorageBacking(type=None, datastore_id=None, storage_uri=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageBacking class defines a storage location where content in a +library will be stored. The storage location can either be a Datastore or +Other type.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (StorageBacking.Type) – Type (DATASTORE, OTHER) of StorageBacking. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • datastore_id (str) – Identifier of the datastore used to store the content in the +library. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is optional and it is only relevant when the value +of type is StorageBacking.Type.DATASTORE.

    • +

  • storage_uri (str) –

    URI identifying the location used to store the content in the +library.

    +

    The following URI formats are supported:

    +

    vSphere 6.5

    + +

    vSphere 6.0 Update 1

    +
      +

    • nfs://server:/path (for vCenter Server Appliance only)

      • +

    • file://unc-server/path (for vCenter Server for Windows only)

      • +

    • file:///mount/point (for vCenter Server Appliance only) - Local +file URIs are supported only when the path is a local mount point +for an NFS file system. Use of file URIs is strongly discouraged. +Instead, use an NFS URI to specify the remote file system.

      • +
    +

    vSphere 6.0

    + +

    This attribute is optional and it is only relevant when the value +of type is StorageBacking.Type.OTHER.

    +

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The StorageBacking.Type class specifies the type of the +StorageBacking.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DATASTORE = Type(string='DATASTORE')
+

The content of the library will be stored on a datastore.

+

These are vCenter Server managed datastores, and are logical containers +that hide specifics of each storage device. Depending on the type of +storage you use, datastores can be backed by the following file system +formats:

+
    +

  • Virtual Machine File System (VMFS)

    • +

  • Network File System (NFS)

    • +
+
+ +
+
+OTHER = Type(string='OTHER')
+

The content of the library will be stored on a remote file system.

+

Supports the following remote file systems:

+
    +

  • NFS (on vCenter Server Appliance)

    • +

  • SMB (on vCenter Server Appliance and vCenter Server for Windows)

    • +
+
+ +
+ +
+ +
+
+class com.vmware.content.library_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.content.library_client.SubscribedItem(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SubscribedItem class manages the unique features of library items +that are members of a subscribed library.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+evict(library_item_id)
+

Evicts the cached content of a library item in a subscribed library.

+

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 +item is synchronized on-demand. When a library is not synchronized +on-demand, it always attempts to keep its cache up-to-date with the +published source. Evicting the library item will set +ItemModel.cached to false.

+
+
Parameters
+

library_item_id (str) – Identifier of the library item whose content should be evicted. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by library_item_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library item specified by library_item_id is not a +member of a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementConfiguration +if the library item specified by library_item_id is a member of +a subscribed library that does not synchronize on-demand.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the content of the library item specified by library_item_id +has been deleted from the storage backings (see +LibraryModel#storageBackings) associated with it.

+

For instance, this {\@term error) is reported on evicting a +library item in an on-demand subscribed library that was restored +from backup, and the library item was deleted after backup, thus +resulting in its content being deleted from the associated storage +backings. In this scenario, the metadata of the library item is +present on a restore, while its content has been deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.EvictLibraryItem.

    • +
+
+
+
+ +
+
+sync(library_item_id, force_sync_content, sync_optional_files=None)
+

Forces the synchronization of an individual library item in a +subscribed library.

+

Synchronizing an individual item will update that item’s metadata from +the remote source. If the source library item on the remote library has +been deleted, this method will delete the library item from the +subscribed library as well.

+

The default behavior of the synchronization is determined by the +SubscriptionInfo of the library which owns the library item.

+
    +

  • If SubscriptionInfo.on_demand is true, then the file content +is not synchronized by default. In this case, only the library item +metadata is synchronized. The file content may still be forcefully +synchronized by passing true for the force_sync_content parameter.

    • +

  • If SubscriptionInfo.on_demand is false, then this call will +always synchronize the file content. The force_sync_content +parameter is ignored when the subscription is not on-demand.

    • +
+

When the file content has been synchronized, the +ItemModel.cached attribute will be true.

+

This method will return immediately and create an asynchronous task to +perform the synchronization.

+
+
Parameters
+
    +

  • library_item_id (str) – Identifier of the library item to synchronize. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • force_sync_content (bool) – Whether to synchronize file content as well as metadata. This +parameter applies only if the subscription is on-demand.

    • +

  • sync_optional_files (bool or None) – Whether to synchronize optional files. This parameter applies to +both types of subscriptions on-demand as well as sync-immediately. +This parameter was added in vSphere API 7.0.3.0. +This parameter is optional because it was added in a newer version +than its parent node.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by library_item_id could not be +found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library item specified by library_item_id is not a +member of a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the content of the library item specified by library_item_id +has been deleted from the storage backings (see +LibraryModel#storageBackings) associated with it.

+

For instance, this {\@term error) is reported on synchronizing a +library item in a subscribed library that was restored from backup, +and the library item was deleted after backup, thus resulting in +its content being deleted from the associated storage backings. In +this scenario, the metadata of the library item is present on a +restore, while its content has been deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.SyncLibraryItem.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library_client.SubscriptionInfo(authentication_method=None, automatic_sync_enabled=None, on_demand=None, password=None, ssl_thumbprint=None, subscription_url=None, user_name=None, source_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SubscriptionInfo class defines the subscription behavior for a +subscribed library.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • authentication_method (SubscriptionInfo.AuthenticationMethod) – Indicate how the subscribed library should authenticate (BASIC, +NONE) with the published library endpoint. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +

  • automatic_sync_enabled (bool) – Whether the library should participate in automatic library +synchronization. In order for automatic synchronization to happen, +the global +com.vmware.content_client.ConfigurationModel.automatic_sync_enabled +option must also be true. The subscription is still active even +when automatic synchronization is turned off, but synchronization +is only activated with an explicit call to +com.vmware.content_client.SubscribedLibrary.sync() or +SubscribedItem.sync(). In other words, manual synchronization +is still available even when automatic synchronization is disabled. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +

  • on_demand (bool) –

    Indicates whether a library item’s content will be synchronized +only on demand.

    +

    If this is set to true, then the library item’s metadata will +be synchronized but the item’s content (its files) will not be +synchronized. The Content Library Service will synchronize the +content upon request only. This can cause the first use of the +content to have a noticeable delay.

    +

    Items without synchronized content can be forcefully synchronized +in advance using the SubscribedItem.sync() call with +forceSyncContent set to true. Once content has been +synchronized, the content can removed with the +SubscribedItem.evict() call.

    +

    If this value is set to false, all content will be synchronized +in advance. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    +

    • +

  • password (str) –

    The password to use when authenticating.

    +

    The password must be set when using a password-based authentication +method; empty strings are not allowed. +This attribute is optional for the create method. It will not +be present in the return value of the get or list methods. +It is optional for the update method.

    +

    • +

  • ssl_thumbprint (str) –

    An optional SHA-1 hash of the SSL certificate for the remote +endpoint.

    +

    If this value is defined the SSL certificate will be verified by +comparing it to the SSL thumbprint. The SSL certificate must verify +against the thumbprint. When specified, the standard certificate +chain validation behavior is not used. The certificate chain is +validated normally if this value is None. The specified +sslThumbprint will not be checked for SSL certificate validation if +{SubscriptionInfo#sslCertificate} is also set. +This attribute is optional for the create method. It will not +be present in the return value of the get or list methods. +It is optional for the update method.

    +

    • +

  • subscription_url (str) –

    The URL of the endpoint where the metadata for the remotely +published library is being served.

    +

    This URL can be the PublishInfo.publish_url of the +published library (for example, https://server/path/lib.json).

    +

    If the source content comes from a published library with +PublishInfo.persist_json_enabled, the subscription URL can +be a URL pointing to the library JSON file on a datastore or remote +file system. The supported formats are:

    +

    vSphere 6.5

    + +

    vSphere 6.0

    + +

    When you specify a DS subscription URL, the datastore must be on +the same vCenter Server as the subscribed library. When you specify +an NFS or SMB subscription URL, the +StorageBacking.storage_uri of the subscribed library must +be on the same remote file server and should share a common parent +path with the subscription URL. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    +

    • +

  • user_name (str) –

    The username to use when authenticating.

    +

    The username must be set when using a password-based authentication +method. Empty strings are allowed for usernames. +This attribute is optional for the create method. It is +optional in the return value of the get or list methods. It +is optional for the update method.

    +

    • +

  • source_info (SourceInfo) – Information about the source published library. This attribute will +be set for a subscribed library which is associated with a +subscription of the published library. This attribute was added in +vSphere API 6.7.2. +This attribute is optional for the create method. It is +optional in the return value of the get or list methods. It +is optional for the update method.

    • +
+
+
+
+
+class AuthenticationMethod(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Indicate how the subscribed library should authenticate with the published +library endpoint.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the AuthenticationMethod instance.

+
+
+
+
+BASIC = AuthenticationMethod(string='BASIC')
+

Require HTTP Basic authentication matching a specified username and +password.

+
+ +
+
+NONE = AuthenticationMethod(string='NONE')
+

Require no authentication.

+
+ +
+ +
+ +
+
+class com.vmware.content.library_client.Subscriptions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Subscriptions class provides methods for managing the subscription +information of the subscribers of a published library. This class was added +in vSphere API 6.7.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(subscribed_library=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.CreateSpec class defines the information required to +create a new subscription of the published library. This class was added in +vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

subscribed_library (Subscriptions.CreateSpecSubscribedLibrary) – Specification for the subscribed library to be associated with the +subscription. This attribute was added in vSphere API 6.7.2.

+
+
+
+ +
+
+class CreateSpecNewSubscribedLibrary(name=None, description=None, storage_backings=None, automatic_sync_enabled=None, on_demand=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.CreateSpecNewSubscribedLibrary class defines the +information required to create a new subscribed library. This class was +added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the subscribed library. This attribute was added in vSphere +API 6.7.2.

    • +

  • description (str or None) – Description of the subscribed library. This attribute was added in +vSphere API 6.7.2. +If None, the description will be an empty string.

    • +

  • storage_backings (list of StorageBacking) –

    The list of default storage backings for this library.

    +

    The list must contain exactly one storage backing. Multiple default +storage locations are not currently supported but may become +supported in future releases.. This attribute was added in vSphere +API 6.7.2.

    +

    • +

  • automatic_sync_enabled (bool) – Specifies whether the library should participate in automatic +library synchronization. This attribute was added in vSphere API +6.7.2.

    • +

  • on_demand (bool) – Specifies whether a library item’s content will be synchronized +only on demand. This attribute was added in vSphere API 6.7.2.

    • +
+
+
+
+ +
+
+class CreateSpecPlacement(folder=None, cluster=None, resource_pool=None, host=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.CreateSpecPlacement class defines the placement +information for the subscribed library’s virtual machine template library +items. Storage location of the virtual machine template items is defined by +the subscribed library’s storage backing. This placement information needs +to be compatible with the subscribed library’s storage backing. The +Subscriptions.CreateSpecPlacement class is only applicable for the +virtual machine template library items of the subscribed library. This +class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine template +should be placed. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Folder:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Folder:VCenter. +This attribute is currently required. In future, if this is None, +the system will attempt to choose a suitable folder for the virtual +machine template; if a folder cannot be chosen, publishing a +virtual machine template item will fail.

    • +

  • cluster (str or None) – Cluster onto which the virtual machine template should be placed. +If cluster and resourcePool are both specified, +resourcePool must belong to cluster. If cluster and +host are both specified, host must be a member of +cluster. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource:VCenter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: ClusterComputeResource:VCenter. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine template should be +placed. If host and resourcePool are both specified, +resourcePool must belong to host. If cluster and +resourcePool are both specified, resourcePool must belong +to cluster. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: ResourcePool:VCenter. +This attribute is currently required. In future, if this is None, +the system will attempt to choose a suitable resource pool for the +virtual machine template; if a resource pool cannot be chosen, +publish of virtual machine template item will fail.

    • +

  • host (str or None) – Host onto which the virtual machine template should be placed. If +host and resourcePool are both specified, resourcePool +must belong to host. If host and cluster are both +specified, host must be a member of cluster. This attribute +was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: HostSystem:VCenter. +If this is None, the system will attempt to choose a suitable host +for the virtual machine template; if a host cannot be chosen, +publishing the virtual machine template item will fail.

    • +

  • network (str or None) – Network that backs the virtual Ethernet adapters in the virtual +machine template. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +If None, the virtual Ethernet adapters will not be backed by a +network.

    • +
+
+
+
+ +
+
+class CreateSpecSubscribedLibrary(target=None, new_subscribed_library=None, subscribed_library=None, location=None, vcenter=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.CreateSpecSubscribedLibrary class defines the +subscribed library information used to create the subscription. This class +was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • target (Subscriptions.CreateSpecSubscribedLibrary.Target) – Specifies whether the target subscribed library should be newly +created or an existing subscribed library should be used. This +attribute was added in vSphere API 6.7.2.

    • +

  • new_subscribed_library (Subscriptions.CreateSpecNewSubscribedLibrary) – Specification for creating a new subscribed library associated with +the subscription. This attribute was added in vSphere API 6.7.2. +This attribute is optional and it is only relevant when the value +of target is +Subscriptions.CreateSpecSubscribedLibrary.Target.CREATE_NEW.

    • +

  • subscribed_library (str) – Identifier of the existing subscribed library to associate with the +subscription. Only the subscribed libraries for which +SubscriptionInfo.subscription_url property is set to the +PublishInfo.publish_url of the published library can be +associated with the subscription. This attribute was added in +vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +This attribute is optional and it is only relevant when the value +of target is +Subscriptions.CreateSpecSubscribedLibrary.Target.USE_EXISTING.

    • +

  • location (Subscriptions.Location) – Location of the subscribed library relative to the published +library. This attribute was added in vSphere API 6.7.2.

    • +

  • vcenter (Subscriptions.CreateSpecVcenter) – Specification for the subscribed library’s vCenter Server instance. +This attribute was added in vSphere API 6.7.2. +This attribute is optional and it is only relevant when the value +of location is Subscriptions.Location.REMOTE.

    • +

  • placement (Subscriptions.CreateSpecPlacement or None) – Placement specification for the virtual machine template library +items on the subscribed library. This attribute was added in +vSphere API 6.7.2. +This attribute is currently required. In future, if this is None, +the system will attempt to choose a suitable placement +specification for the virtual machine template items; if a +placement specification cannot be chosen, publish of virtual +machine template items will fail.

    • +
+
+
+
+
+class Target(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Subscriptions.CreateSpecSubscribedLibrary.Target class defines the +options related to the target subscribed library which will be associated +with the subscription. This enumeration was added in vSphere API 6.7.2.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Target instance.

+
+
+
+
+CREATE_NEW = Target(string='CREATE_NEW')
+

Create a new subscribed library. This class attribute was added in vSphere +API 6.7.2.

+
+ +
+
+USE_EXISTING = Target(string='USE_EXISTING')
+

Use the specified existing subscribed library. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+ +
+ +
+
+class CreateSpecVcenter(hostname=None, https_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.CreateSpecVcenter class defines information about the +vCenter Server instance where the subscribed library associated with the +subscription exists or will be created. This class was added in vSphere API +6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The hostname of the subscribed library’s vCenter Server. This +attribute was added in vSphere API 6.7.2.

    • +

  • https_port (long or None) – The HTTPS port of the vCenter Server instance where the subscribed +library exists. This attribute was added in vSphere API 6.7.2. +If None, port 443 will be used.

    • +
+
+
+
+ +
+
+class Info(subscribed_library=None, subscribed_library_name=None, subscribed_library_location=None, subscribed_library_vcenter=None, subscribed_library_placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.Info class contains information about the +subscription. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • subscribed_library (str) – Identifier of the subscribed library associated with the +subscription. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

    • +

  • subscribed_library_name (str) – Name of the subscribed library associated with the subscription. +This attribute was added in vSphere API 6.7.2.

    • +

  • subscribed_library_location (Subscriptions.Location) – Location of the subscribed library relative to the published +library. This attribute was added in vSphere API 6.7.2.

    • +

  • subscribed_library_vcenter (Subscriptions.VcenterInfo) – Information about the vCenter Server instance where the subscribed +library exists. This attribute was added in vSphere API 6.7.2. +This attribute is optional and it is only relevant when the value +of subscribedLibraryLocation is +Subscriptions.Location.REMOTE.

    • +

  • subscribed_library_placement (Subscriptions.PlacementInfo) – Placement information about the subscribed library’s virtual +machine template items. This attribute was added in vSphere API +6.7.2.

    • +
+
+
+
+ +
+
+class Location(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Subscriptions.Location class defines the location of subscribed +library relative to the published library. This enumeration was added in +vSphere API 6.7.2.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Location instance.

+
+
+
+
+LOCAL = Location(string='LOCAL')
+

The subscribed library belongs to the same vCenter instance as the +published library. This class attribute was added in vSphere API 6.7.2.

+
+ +
+
+REMOTE = Location(string='REMOTE')
+

The subscribed library belongs to a different vCenter instance than the +published library. This class attribute was added in vSphere API 6.7.2.

+
+ +
+ +
+
+class PlacementInfo(folder=None, cluster=None, resource_pool=None, host=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.PlacementInfo class contains the placement +information for the subscribed library’s virtual machine template library +items. The Subscriptions.PlacementInfo class is only applicable for the +virtual machine template library items of the subscribed library. This +class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine template +should be placed. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Folder:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Folder:VCenter. +The attribute will be None if the subscribed library associated +with the subscription does not have a virtual machine folder.

    • +

  • cluster (str or None) – Cluster onto which the virtual machine template should be placed. +This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource:VCenter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: ClusterComputeResource:VCenter. +The attribute will be None if the subscribed library associated +with the subscription does not have a cluster.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine template should be +placed. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: ResourcePool:VCenter. +The attribute will be None if the subscribed library associated +with the subscription does not have a resource pool.

    • +

  • host (str or None) – Host onto which the virtual machine template should be placed. If +host and resourcePool are both specified, resourcePool +must belong to host. If host and cluster are both +specified, host must be a member of cluster. This attribute +was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: HostSystem:VCenter. +The attribute will be None if the subscribed library associated +with the subscription does not have a host.

    • +

  • network (str or None) – Network that backs the virtual Ethernet adapters in the virtual +machine template. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +The attribute will be None if the subscribed library associated +with the subscription does not have a network.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.library.Subscriptions'
+

Resource type for Subscription resource. This class attribute was added in +vSphere API 6.7.2.

+
+ +
+
+class Summary(subscription=None, subscribed_library=None, subscribed_library_name=None, subscribed_library_vcenter_hostname=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.Summary class contains commonly used information +about the subscription. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • subscription (str) – Identifier of the subscription. This attribute was added in vSphere +API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Subscriptions. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.Subscriptions.

    • +

  • subscribed_library (str) – Identifier of the subscribed library. This attribute was added in +vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

    • +

  • subscribed_library_name (str) – Name of the subscribed library. This attribute was added in vSphere +API 6.7.2.

    • +

  • subscribed_library_vcenter_hostname (str or None) – Hostname of the vCenter instance where the subscribed library +exists. This attribute was added in vSphere API 6.7.2. +This attribute is unset if the subscribed library is on the same +vCenter Server instance as the published library.

    • +
+
+
+
+ +
+
+class UpdateSpec(subscribed_library_vcenter=None, subscribed_library_placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.UpdateSpec class defines information required to +update the subscription. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • subscribed_library_vcenter (Subscriptions.UpdateSpecVcenter or None) – Specification for the subscribed library’s vCenter Server instance. +This attribute was added in vSphere API 6.7.2. +If None, the value is unchanged.

    • +

  • subscribed_library_placement (Subscriptions.UpdateSpecPlacement or None) – Placement specification for the virtual machine template items of +the subscribed library. Updating this information will only affect +new or updated items, existing items will not be moved. The entire +placement configuration of the subscribed library will replaced by +the new specification. This attribute was added in vSphere API +6.7.2. +If None, the placement configuration of the subscribed library will +be unchanged.

    • +
+
+
+
+ +
+
+class UpdateSpecPlacement(folder=None, cluster=None, resource_pool=None, host=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.UpdateSpecPlacement class defines the placement +information for the subscribed library’s virtual machine template library +items. Storage location of the virtual machine template items is defined by +the subscribed library’s storage backing. This placement information needs +to be compatible with the subscribed library’s storage backing. The +Subscriptions.UpdateSpecPlacement class is only applicable for the +newly published virtual machine template library items of the subscribed +library. Existing items will not be moved. This class was added in vSphere +API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine template +should be placed. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Folder:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Folder:VCenter. +This attribute is currently required. In future, if this is None, +the system will attempt to choose a suitable folder for the virtual +machine template; if a folder cannot be chosen, publishing a +virtual machine template item will fail.

    • +

  • cluster (str or None) – Cluster onto which the virtual machine template should be placed. +If cluster and resourcePool are both specified, +resourcePool must belong to cluster. If cluster and +host are both specified, host must be a member of +cluster. If resourcePool or host is specified, it is +recommended that this attribute be None. This attribute was added +in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource:VCenter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: ClusterComputeResource:VCenter. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine template should be +placed. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: ResourcePool:VCenter. +This attribute is currently required. In future, if this is None, +the system will attempt to choose a suitable resource pool for the +virtual machine template; if a resource pool cannot be chosen, +publish of virtual machine template item will fail.

    • +

  • host (str or None) – Host onto which the virtual machine template should be placed. If +host and resourcePool are both specified, resourcePool +must belong to host. If host and cluster are both +specified, host must be a member of cluster. This attribute +was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: HostSystem:VCenter. +If this is None, the system will attempt to choose a suitable host +for the virtual machine template; if a host cannot be chosen, +publishing the virtual machine template item will fail.

    • +

  • network (str or None) – Network that backs the virtual Ethernet adapters in the virtual +machine template. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +If None, newly published virtual machine template library items +will not be backed by a network.

    • +
+
+
+
+ +
+
+class UpdateSpecVcenter(hostname=None, https_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.UpdateSpecVcenter class defines information about the +vCenter Server instance where the subscribed library associated with the +subscription exists. The Subscriptions.UpdateSpecVcenter class is only +applicable to subscribed library which exists on remote vCenter Server +instance. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str or None) – The hostname of the subscribed library’s vCenter Server. This +attribute was added in vSphere API 6.7.2. +If None, the value is unchanged.

    • +

  • https_port (long or None) – The HTTPS port of the vCenter Server instance where the subscribed +library exists. This attribute was added in vSphere API 6.7.2. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+class VcenterInfo(hostname=None, https_port=None, server_guid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Subscriptions.VcenterInfo class contains information about the +vCenter Server instance where the subscribed library associated with the +subscription exists. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – Hostname of the vCenter Server instance where the subscribed +library exists. This attribute was added in vSphere API 6.7.2.

    • +

  • https_port (long or None) – The HTTPS port of the vCenter Server instance where the subscribed +library exists. This attribute was added in vSphere API 6.7.2. +If None, port 443 will be used.

    • +

  • server_guid (str) – The unique identifier of the vCenter Server where the subscribed +library exists. This attribute was added in vSphere API 6.7.2.

    • +
+
+
+
+ +
+
+create(library, spec, client_token=None)
+

Creates a subscription of the published library. This method was added +in vSphere API 6.7.2.

+
+
Parameters
+
    +

  • client_token (str or None) – A unique token generated on the client for each creation request. +The token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified, creation is not idempotent.

    • +

  • library (str) – Identifier of the published library. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • spec (Subscriptions.CreateSpec) – Specification for the subscription.

    • +
+
+
Return type
+

str

+
+
Returns
+

Subscription identifier. +The return value will be an identifier for the resource type: +com.vmware.content.library.Subscriptions.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If a subscription of the published library to the specified +subscribed library already exists. This is only applicable when +subscribedLibrary#subscribedLibrary is specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library specified by library does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the subscribed library specified by +subscribedLibrary#subscribedLibrary does not exist at the +vCenter instance specified by subscribedLibrary#vcenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +If the vCenter instance specified by subscribedLibrary#vcenter +cannot be contacted or found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If Subscriptions.CreateSpec contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library specified by library is a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library specified by library is not a published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library requires ContentLibrary.AddSubscription.

    • +
+
+
+
+ +
+
+delete(library, subscription)
+

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.

+
+
Parameters
+
    +

  • library (str) – Identifier of the published library. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • subscription (str) – Subscription identifier. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Subscriptions.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library specified by library is a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library specified by library is not a published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library specified by library does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the subscription specified by subscription does not exist +for the library specified by library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library requires +ContentLibrary.DeleteSubscription.

    • +
+
+
+
+ +
+
+get(library, subscription)
+

Returns information about the specified subscription of the published +library. This method was added in vSphere API 6.7.2.

+
+
Parameters
+
    +

  • library (str) – Identifier of the published library. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • subscription (str) – Identifier of the subscription. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Subscriptions.

    • +
+
+
Return type
+

Subscriptions.Info

+
+
Returns
+

Information about the subscription.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library specified by library does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the subscription is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library specified by library is a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library specified by library is not a published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library requires System.Read.

    • +
+
+
+
+ +
+
+list(library)
+

Lists the subscriptions of the published library. This method was added +in vSphere API 6.7.2.

+
+
Parameters
+

library (str) – Identifier of the published library. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Return type
+

list of Subscriptions.Summary

+
+
Returns
+

List of commonly used information about subscriptions of the +published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library specified by library is a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library specified by library does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library specified by library is not a published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library requires System.Read.

    • +
+
+
+
+ +
+
+update(library, subscription, spec)
+

Updates the specified subscription of the published library.

+

This is an incremental update to the subscription. Except for the +Subscriptions.UpdateSpecPlacement class, attributes that are +None in the update specification will be left unchanged. If +spec#subscribedLibraryPlacement is specified, all attributes of the +current subscribed library placement will be replaced by this +placement.. This method was added in vSphere API 6.7.2.

+
+
Parameters
+
    +

  • library (str) – Identifier of the published library. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • subscription (str) – subscription identifier. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Subscriptions.

    • +

  • spec (Subscriptions.UpdateSpec) – Specification of the new property values to set on the +subscription.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library specified by library does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the subscription specified by subscription does not exist +for the library specified by library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +If the subscribed library cannot be contacted or found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If Subscriptions.UpdateSpec contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library specified by library is a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library specified by library is not a published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library requires +ContentLibrary.UpdateSubscription.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.content.library.html b/vsphere/8.0.2.0/com.vmware.content.library.html new file mode 100644 index 00000000..228e99c0 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.content.library.html @@ -0,0 +1,1808 @@ + + + + + + + com.vmware.content.library package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.content.library package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.content.library.item_client module

+

The Content Library Item module provides classes and classes for managing files +in a library item.

+
+
+class com.vmware.content.library.item_client.CertVerificationStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CertVerificationStatus class defines the certificate verification +status of a library item. Currently applicable only to ovf item type. This +enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CertVerificationStatus instance.

+
+
+
+
+INTERNAL = CertVerificationStatus(string='INTERNAL')
+

The Item is cloned/created through vCenter. This class attribute was added +in vSphere API 7.0.3.0.

+
+ +
+
+NOT_AVAILABLE = CertVerificationStatus(string='NOT_AVAILABLE')
+

Existing library item which can not be verified. Applying security policy +to an existing library may result in this status for items. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+UNTRUSTED = CertVerificationStatus(string='UNTRUSTED')
+

Certificate used to sign the item is not trusted. This class attribute was +added in vSphere API 7.0.3.0.

+
+ +
+
+VERIFICATION_FAILURE = CertVerificationStatus(string='VERIFICATION_FAILURE')
+

Item’s certificate or manifest validation failed. This class attribute was +added in vSphere API 7.0.3.0.

+
+ +
+
+VERIFICATION_IN_PROGRESS = CertVerificationStatus(string='VERIFICATION_IN_PROGRESS')
+

Item certificate verification is in progress. This class attribute was +added in vSphere API 7.0.3.0.

+
+ +
+
+VERIFIED = CertVerificationStatus(string='VERIFIED')
+

Item has been fully validated during importing or file syncing. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class com.vmware.content.library.item_client.CertificateVerificationInfo(status=None, cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Currently, this field will available only in following cases 1. This item +belongs to a secure content library 2. The item if of type ovf. This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (CertVerificationStatus) – The certificate verification status of item. This attribute was +added in vSphere API 7.0.3.0.

    • +

  • cert_chain (list of str or None) – A certificate in base64 encoding. This attribute was added in +vSphere API 7.0.3.0. +Certificate chain is unset if the item not signed

    • +
+
+
+
+ +
+
+class com.vmware.content.library.item_client.Changes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Changes 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.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(time=None, user=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Changes.Info class contains information about a library item +change. This class was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • time (datetime.datetime) – The date and time when the item content was changed. This attribute +was added in vSphere API 6.9.1.

    • +

  • user (str or None) – 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.

    • +

  • message (str or None) – 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.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.library.item.Version'
+

Resource type for library item versions. This class attribute was added in +vSphere API 6.9.1.

+
+ +
+
+class Summary(version=None, time=None, user=None, short_message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Changes.Summary class contains commonly used information about a +library item change. This class was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – 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: +com.vmware.content.library.item.Version. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.item.Version.

    • +

  • time (datetime.datetime) – The date and time when the item content was changed. This attribute +was added in vSphere API 6.9.1.

    • +

  • user (str or None) – 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.

    • +

  • short_message (str or None) – 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.

    • +
+
+
+
+ +
+
+get(library_item, version)
+

Returns information about a library item change. This method was added +in vSphere API 6.9.1.

+
+
Parameters
+
    +

  • library_item (str) – Library item identifer. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • version (str) – Library item version. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.Version.

    • +
+
+
Return type
+

Changes.Info

+
+
Returns
+

Information about the specified library item change.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item or version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item requires System.Read.

    • +
+
+
+
+ +
+
+list(library_item)
+

Returns commonly used information about the content changes made to a +library item. This method was added in vSphere API 6.9.1.

+
+
Parameters
+

library_item (str) – Library item identifier. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

list of Changes.Summary

+
+
Returns
+

List of commonly used information about the library item changes.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item_client.DownloadSession(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DownloadSession class manipulates download sessions, which are used +to download content from the Content Library Service.

+

A download session is an object that tracks the download of content (that +is, downloading content from the Content Library Service) and acts as a +lease to keep the download links available.

+

The com.vmware.content.library.item.downloadsession_client.File +class provides access to the download links.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.content.library.item.DownloadSession'
+

Resource type for a download session.

+
+ +
+
+cancel(download_session_id)
+

Cancels the download session. This method will abort any ongoing +transfers and invalidate transfer urls that the client may be +downloading from.

+
+
Parameters
+

download_session_id (str) – Identifer of the download session that should be canceled. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no download session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the download session is not in the +DownloadSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+create(create_spec, client_token=None)
+

Creates a new download session.

+
+
Parameters
+
    +

  • client_token (str or None) – A unique token generated by the client for each creation request. +The token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified creation is not idempotent.

    • +

  • create_spec (DownloadSessionModel) – Specification for the new download session to be created.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the new download session being created. +The return value will be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the session specification is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item targeted by the download does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the attribute DownloadSessionModel.library_item_id requires +ContentLibrary.DownloadSession.

    • +
+
+
+
+ +
+
+delete(download_session_id)
+

Deletes a download session. This removes the session and all +information associated with it.

+

Removing a download session leaves any current transfers for that +session in an indeterminate state (there is no guarantee that the +transfers will be able to complete). However there will no longer be a +means of inspecting the status of those downloads except by seeing the +effect on the library item.

+

Download sessions for which there is no download activity or which are +complete will automatically be expired and then deleted after a period +of time.

+
+
Parameters
+

download_session_id (str) – Identifier of the download session to be deleted. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the download session does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+fail(download_session_id, client_error_message)
+

Terminates the download session with a client specified error message.

+

This is useful in transmitting client side failures (for example, not +being able to download a file) to the server side.

+
+
Parameters
+
    +

  • download_session_id (str) – Identifier of the download session to fail. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

    • +

  • client_error_message (str) – Client side error message. This can be useful in providing some +extra details about the client side failure. Note that the message +won’t be translated to the user’s locale.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the download session does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the download session is not in the +DownloadSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+get(download_session_id)
+

Gets the download session with the specified identifier, including the +most up-to-date status information for the session.

+
+
Parameters
+

download_session_id (str) – Identifier of the download session to retrieve. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

+
+
Return type
+

DownloadSessionModel

+
+
Returns
+

The DownloadSessionModel instance with the given +download_session_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no download session with the given download_session_id +exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+keep_alive(download_session_id, progress=None)
+

Keeps a download session alive. This operation is allowed only if the +session is in the DownloadSessionModel.State.ACTIVE state.

+

If there is no activity for a download session for a certain period of +time, the download session will expire. The download session expiration +timeout is configurable in the Content Library Service system +configuration. The default is five minutes. Invoking this method +enables a client to specifically extend the lifetime of an active +download session.

+
+
Parameters
+
    +

  • download_session_id (str) – Identifier of the download session whose lifetime should be +extended. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

    • +

  • progress (long or None) – Optional update to the progress property of the session. If +specified, the new progress should be greater then the current +progress. See DownloadSessionModel.client_progress. +If not specified the progress is not updated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no download session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the download session is not in the +DownloadSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+list(library_item_id=None)
+

Lists the identifiers of the download sessions created by the calling +user. Optionally may filter by library item.

+
+
Parameters
+

library_item_id (str or None) – Library item identifier on which to filter results. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession. +If not specified all download session identifiers are listed.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of all download sessions created +by the calling user. +The return value will contain identifiers for the resource type: +com.vmware.content.library.item.DownloadSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a library item identifier is given for an item which does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.item.DownloadSession +referenced by the parameter library_item_id requires +ContentLibrary.DownloadSession.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item_client.DownloadSessionModel(id=None, library_item_id=None, library_item_content_version=None, error_message=None, client_progress=None, state=None, expiration_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DownloadSessionModel class provides information on an active +DownloadSession resource.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The identifier of this download session. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession. +This attribute is not used for the create method. It will not +be present in the return value of the get or list methods. +It is not used for the update method.

    • +

  • library_item_id (str) – The identifier of the library item whose content is being +downloaded. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • library_item_content_version (str) – The content version of the library item whose content is being +downloaded. This value is the +com.vmware.content.library_client.ItemModel.content_version +at the time when the session is created for the library item. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • error_message (com.vmware.vapi.std_client.LocalizableMessage) – If the session is in the DownloadSessionModel.State.ERROR +status this property will have more details about the error. +This attribute is not used for the create method. It is +optional in the return value of the get or list methods. It +is not used for the update method.

    • +

  • client_progress (long) – The progress that has been made with the download. This property is +to be updated by the client during the download process to indicate +the progress of its work in completing the download. The initial +progress is 0 until updated by the client. The maximum value is +100, which indicates that the download is complete. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +

  • state (DownloadSessionModel.State) – The current state (ACTIVE, CANCELED, ERROR) of the download +session. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • expiration_time (datetime.datetime) – Indicates the time after which the session will expire. The session +is guaranteed not to expire before this time. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +
+
+
+
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The state of the download session.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+ACTIVE = State(string='ACTIVE')
+

The session is active. Individual files may be in the process of being +transferred and may become ready for download at different times.

+
+ +
+
+CANCELED = State(string='CANCELED')
+

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.

+
+ +
+
+ERROR = State(string='ERROR')
+

Indicates there was an error during the session lifecycle.

+
+ +
+ +
+ +
+
+class com.vmware.content.library.item_client.File(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The File 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 +the UpdateSession and +com.vmware.content.library.item.updatesession_client.File classes.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ChecksumAlgorithm(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The File.ChecksumAlgorithm class defines the valid checksum algorithms.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ChecksumAlgorithm instance.

+
+
+
+
+MD5 = ChecksumAlgorithm(string='MD5')
+

Checksum algorithm: MD5

+
+ +
+
+SHA1 = ChecksumAlgorithm(string='SHA1')
+

Checksum algorithm: SHA-1

+
+ +
+
+SHA256 = ChecksumAlgorithm(string='SHA256')
+

Checksum algorithm: SHA-256. This class attribute was added in vSphere API +6.8.

+
+ +
+
+SHA512 = ChecksumAlgorithm(string='SHA512')
+

Checksum algorithm: SHA-512. This class attribute was added in vSphere API +6.8.

+
+ +
+ +
+
+class ChecksumInfo(algorithm=None, checksum=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provides checksums for a File.Info object.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • algorithm (File.ChecksumAlgorithm or None) – The checksum algorithm (SHA1, MD5, SHA256, SHA512) used to +calculate the checksum. +If not specified the default checksum algorithm is +File.ChecksumAlgorithm.SHA1.

    • +

  • checksum (str) – The checksum value calculated with +File.ChecksumInfo.algorithm.

    • +
+
+
+
+ +
+
+class Info(checksum_info=None, name=None, size=None, cached=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The File.Info class provides information about a file in Content +Library Service storage.

+

A file is an actual stored object for a library item. An item will have +zero files initially, but one or more can be uploaded to the item.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • checksum_info (File.ChecksumInfo or None) –

    A checksum for validating the content of the file.

    +

    This value can be used to verify that a transfer was completed +without errors. +A checksum cannot always be calculated, and the value will be None +if the file does not have content.

    +

    • +

  • name (str) –

    The name of the file.

    +

    This value will be unique within the library item for each file. It +cannot be an empty string.

    +

    • +

  • size (long) – The file size, in bytes. The file size is the storage used and not +the uploaded or provisioned size. For example, when uploading a +disk to a datastore, the amount of storage that the disk consumes +may be different from the disk file size. When the file is not +cached, the size is 0.

    • +

  • cached (bool) – Indicates whether the file is on disk or not.

    • +

  • version (str) – The version of this file; incremented when a new copy of the file +is uploaded.

    • +
+
+
+
+ +
+
+get(library_item_id, name)
+

Retrieves the information for a single file in a library item by its +name.

+
+
Parameters
+
    +

  • library_item_id (str) – Identifier of the library item whose file information should be +returned. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • name (str) – Name of the file in the library item whose information should be +returned.

    • +
+
+
Return type
+

File.Info

+
+
Returns
+

The File.Info object with information on the specified +file.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if library_item_id refers to a library item that does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if name refers to a file that does not exist in the library +item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires System.Read.

    • +
+
+
+
+ +
+
+list(library_item_id)
+

Lists all of the files that are stored within a given library item.

+
+
Parameters
+

library_item_id (str) – Identifier of the library item whose files should be listed. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

list of File.Info

+
+
Returns
+

The list of all of the files that are stored within the +given library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if library_item_id refers to a library item that does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item_client.Storage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Storage is a resource that represents a specific instance of a file +stored on a storage backing. Unlike File, which is abstract, +storage represents concrete files on the various storage backings. A file +is only represented once in File, but will be represented multiple +times (once for each storage backing) in Storage. The Storage class +provides information on the storage backing and the specific location of +the file in that backing to privileged users who want direct access to the +file on the storage medium.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(storage_backing=None, storage_uris=None, checksum_info=None, name=None, size=None, cached=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Storage.Info class is the expanded form of File.Info that +includes details about the storage backing for a file in a library item.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • storage_backing (com.vmware.content.library_client.StorageBacking) – The storage backing on which this object resides. This might not be +the same as the default storage backing associated with the +library.

    • +

  • storage_uris (list of str) –

    URIs that identify the file on the storage backing.

    +

    These URIs may be specific to the backing and may need +interpretation by the client. A client that understands a URI +scheme in this list may use that URI to directly access the file on +the storage backing. This can provide high-performance support for +file manipulation.

    +

    • +

  • checksum_info (File.ChecksumInfo or None) –

    A checksum for validating the content of the file.

    +

    This value can be used to verify that a transfer was completed +without errors. +A checksum cannot always be calculated, and the value will be None +if the file does not have content.

    +

    • +

  • name (str) –

    The name of the file.

    +

    This value will be unique within the library item for each file. It +cannot be an empty string.

    +

    • +

  • size (long) – The file size, in bytes. The file size is the storage used and not +the uploaded or provisioned size. For example, when uploading a +disk to a datastore, the amount of storage that the disk consumes +may be different from the disk file size. When the file is not +cached, the size is 0.

    • +

  • cached (bool) – Indicates whether the file is on disk or not.

    • +

  • version (str) – The version of this file; incremented when a new copy of the file +is uploaded.

    • +
+
+
+
+ +
+
+get(library_item_id, file_name)
+

Retrieves the storage information for a specific file in a library +item.

+
+
Parameters
+
    +

  • library_item_id (str) – Identifier of the library item whose storage information should be +retrieved. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • file_name (str) – Name of the file for which the storage information should be +listed.

    • +
+
+
Return type
+

list of Storage.Info

+
+
Returns
+

The list of all the storage items for the given file +within the given library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified library item does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified file does not exist in the given library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.ReadStorage.

    • +
+
+
+
+ +
+
+list(library_item_id)
+

Lists all storage items for a given library item.

+
+
Parameters
+

library_item_id (str) – Identifier of the library item whose storage information should be +listed. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

list of Storage.Info

+
+
Returns
+

The list of all storage items for a given library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified library item does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item_id requires +ContentLibrary.ReadStorage.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.content.library.item_client.TransferEndpoint(uri=None, ssl_certificate_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TransferEndpoint class encapsulates a URI along with extra +information about it.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • uri (str) –

    Transfer endpoint URI. The supported URI schemes are: http, +https, and ds.

    +

    An endpoint URI with the ds scheme specifies the location of +the file on the datastore. The format of the datastore URI is:

    +
      +

    • ds:///vmfs/volumes/uuid/path

      • +
    +

    When the transfer endpoint is a datastore location, the server can +import the file directly from the storage backing without the +overhead of streaming over HTTP.

    +

    • +

  • ssl_certificate_thumbprint (str or None) – Thumbprint of the expected SSL certificate for this endpoint. Only +used for HTTPS connections. The thumbprint is the SHA-1 hash of the +DER encoding of the remote endpoint’s SSL certificate. If set, the +remote endpoint’s SSL certificate is only accepted if it matches +this thumbprint, and no other certificate validation is performed. +The specified sslCertificateThumbprint will not be checked for SSL +certificate validation if {TransferEndpoint#sslCertificate} is also +set. +If None, standard certificate validation is performed.

    • +
+
+
+
+ +
+
+class com.vmware.content.library.item_client.TransferStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The TransferStatus class defines the transfer state of a file.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the TransferStatus instance.

+
+
+
+
+ERROR = TransferStatus(string='ERROR')
+

Indicates that there was an error transferring or validating the file.

+
+ +
+
+READY = TransferStatus(string='READY')
+

Indicates that the file has been fully transferred and is ready to be used.

+
+ +
+
+TRANSFERRING = TransferStatus(string='TRANSFERRING')
+

Indicates that data is being transferred to the file.

+
+ +
+
+VALIDATING = TransferStatus(string='VALIDATING')
+

Indicates that the file is being validated (checksum, type adapters).

+
+ +
+
+WAITING_FOR_TRANSFER = TransferStatus(string='WAITING_FOR_TRANSFER')
+

Indicates that a file has been defined for a library item and its content +needs to be uploaded.

+
+ +
+ +
+
+class com.vmware.content.library.item_client.UpdateSession(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The UpdateSession class manipulates sessions that are used to upload +content into the Content Library Service, and/or to remove files from a +library item.

+

An update session is a resource which tracks changes to content. An update +session is created with a set of files that are intended to be uploaded to +a specific com.vmware.content.library_client.ItemModel, or removed +from an item. The session object can be used to track the uploads and +inspect the changes that are being made to the item by that upload. It can +also serve as a channel to check on the result of the upload, and status +messages such as errors and warnings for the upload.

+

Modifications are not visible to other clients unless the session is +completed and all necessary files have been received.

+

The management of the files within the session is done through the +com.vmware.content.library.item.updatesession_client.File class.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.content.library.item.UpdateSession'
+

Resource type for an update session.

+
+ +
+
+cancel(update_session_id)
+

Cancels the update session and sets its state to +UpdateSessionModel.State.CANCELED. This method will free up any +temporary resources currently associated with the session.

+

This method is not allowed if the session has been already completed.

+

Cancelling an update session will cancel any in progress transfers +(either uploaded by the client or pulled by the server). Any content +that has been already received will be scheduled for deletion.

+
+
Parameters
+

update_session_id (str) – Identifier of the update session that should be canceled. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no update session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is not in the +UpdateSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+complete(update_session_id)
+

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 +item will be updated once this call returns. If the server is pulling +the content, the call may return before the changes become visible. In +that case, the client can track the session to know when the server is +done.

+

This method requires the session to be in the +UpdateSessionModel.State.ACTIVE state.

+

Depending on the type of the library item associated with this session, +a type adapter may be invoked to verify the validity of the files +uploaded. The user can explicitly validate the session before +completing the session by using the +com.vmware.content.library.item.updatesession_client.File.validate() +method.

+

Modifications are not visible to other clients unless the session is +completed and all necessary files have been received.

+
+
Parameters
+

update_session_id (str) – Identifier of the update session that should be completed. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no update session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is not in the +UpdateSessionModel.State.ACTIVE state, or if some of the +files that will be uploaded by the client aren’t received +correctly.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+create(create_spec, client_token=None)
+

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 +been received.

+

Content Library Service allows only one single update session to be +active for a specific library item.

+
+
Parameters
+
    +

  • client_token (str or None) – Unique token generated by the client for each creation request. The +token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified creation is not idempotent.

    • +

  • create_spec (UpdateSessionModel) – Specification for the new update session to be created.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the new update session being created. +The return value will be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the session specification is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the client_token does not conform to the UUID format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the update session is being created on a subscribed library +item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the item targeted for update does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there is another update session on the same library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.Item referenced by +the attribute UpdateSessionModel.library_item_id requires +ContentLibrary.UpdateSession.

    • +
+
+
+
+ +
+
+delete(update_session_id)
+

Deletes an update session. This removes the session and all information +associated with it.

+

Removing an update session leaves any current transfers for that +session in an indeterminate state (there is no guarantee that the +server will terminate the transfers, or that the transfers can be +completed). However there will no longer be a means of inspecting the +status of those uploads except by seeing the effect on the library +item.

+

Update sessions for which there is no upload activity or which are +complete will automatically be deleted after a period of time.

+
+
Parameters
+

update_session_id (str) – Identifer of the update session to delete. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is in the +UpdateSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+fail(update_session_id, client_error_message)
+

Terminates the update session with a client specified error message.

+

This is useful in transmitting client side failures (for example, not +being able to access a file) to the server side.

+
+
Parameters
+
    +

  • update_session_id (str) – Identifier of the update session to fail. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

    • +

  • client_error_message (str) – Client side error message. This can be useful in providing some +extra details about the client side failure. Note that the message +won’t be translated to the user’s locale.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is not in the +UpdateSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+get(update_session_id)
+

Gets the update session with the specified identifier, including the +most up-to-date status information for the session.

+
+
Parameters
+

update_session_id (str) – Identifier of the update session to retrieve. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Return type
+

UpdateSessionModel

+
+
Returns
+

The UpdateSessionModel instance with the given +update_session_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no update session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+keep_alive(update_session_id, client_progress=None)
+

Keeps an update session alive.

+

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 +expiration timeout is configurable in the Content Library Service +system configuration. The default is five minutes. Invoking this method +enables a client to specifically extend the lifetime of the update +session.

+
+
Parameters
+
    +

  • update_session_id (str) – Identifier of the update session whose lifetime should be extended. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

    • +

  • client_progress (long or None) – Optional update to the progress property of the session. If +specified, the new progress should be greater then the current +progress. See UpdateSessionModel.client_progress. +If not specified the progress is not updated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no update session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is not in the +UpdateSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+list(library_item_id=None)
+

Lists the identifiers of the update session created by the calling +user. Optionally may filter by library item.

+
+
Parameters
+

library_item_id (str or None) – Optional library item identifier on which to filter results. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession. +If not specified the results are not filtered.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of all update sessions created by +the calling user. +The return value will contain identifiers for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a library item identifier is given for an item which does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.library.item.UpdateSession +referenced by the parameter library_item_id requires +ContentLibrary.UpdateSession.

    • +
+
+
+
+ +
+
+update(update_session_id, update_spec)
+

Updates the properties of an update session.

+

This is an incremental update to the update session. Any attribute in +the UpdateSessionModel class that is None will not be +modified.

+

This method will only update the property +UpdateSessionModel.warning_behavior of the update session. This +will not, for example, update the +UpdateSessionModel.library_item_id or +UpdateSessionModel.state of an update session.

+

This method requires the session to be in the +UpdateSessionModel.State.ACTIVE state.. This method was added +in vSphere API 6.8.

+
+
Parameters
+
    +

  • update_session_id (str) – Identifer of the update session that should be updated. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

    • +

  • update_spec (UpdateSessionModel) – Specification for the new property values to be set on the update +session.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is not in the +UpdateSessionModel.State.ACTIVE state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the update session specification is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item_client.UpdateSessionModel(id=None, library_item_id=None, library_item_content_version=None, error_message=None, client_progress=None, state=None, expiration_time=None, preview_info=None, warning_behavior=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UpdateSessionModel class provides information on an active +UpdateSession resource.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The identifier of this update session. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession. +This attribute is not used for the create method. It will not +be present in the return value of the get or list methods. +It is not used for the update method.

    • +

  • library_item_id (str) – The identifier of the library item to which content will be +uploaded or removed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • library_item_content_version (str) – The content version of the library item whose content is being +modified. This value is the +com.vmware.content.library_client.ItemModel.content_version +at the time when the session is created for the library item. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • error_message (com.vmware.vapi.std_client.LocalizableMessage) – If the session is in the UpdateSessionModel.State.ERROR +status this property will have more details about the error. +This attribute is not used for the create method. It is +optional in the return value of the get or list methods. It +is not used for the update method.

    • +

  • client_progress (long) – The progress that has been made with the upload. This property is +to be updated by the client during the upload process to indicate +the progress of its work in completing the upload. The initial +progress is 0 until updated by the client. The maximum value is +100, which indicates that the update is complete. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • state (UpdateSessionModel.State) – The current state (ACTIVE, DONE, ERROR, CANCELED) of the update +session. This attribute was added in vSphere API 6.8. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • expiration_time (datetime.datetime) – Indicates the time after which the session will expire. The session +is guaranteed not to expire earlier than this time. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • preview_info (com.vmware.content.library.item.updatesession_client.PreviewInfo) – A preview of the files currently being uploaded in the session. +This property will be set only when the session is in the +UpdateSessionModel.State.ACTIVE. This attribute was added +in vSphere API 6.8. +This attribute is optional and it is only relevant when the value +of state is UpdateSessionModel.State.ACTIVE.

    • +

  • warning_behavior (list of com.vmware.content.library.item.updatesession_client.WarningBehavior) – Indicates the update session behavior if warnings are raised in the +session preview. Any warning which is raised by session preview but +not ignored by the client will, by default, fail the update +session. This attribute was added in vSphere API 6.8. +This attribute is optional for the create method. It is +optional in the return value of the get or list methods. It +is optional for the update method.

    • +
+
+
+
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The state of an update session.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+ACTIVE = State(string='ACTIVE')
+

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.

+
+ +
+
+CANCELED = State(string='CANCELED')
+

The session has been canceled.

+
+ +
+
+DONE = State(string='DONE')
+

The session is done and all its effects are now visible.

+
+ +
+
+ERROR = State(string='ERROR')
+

There was an error during the session.

+
+ +
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.content.library.item.html b/vsphere/8.0.2.0/com.vmware.content.library.item.html new file mode 100644 index 00000000..50e3aef3 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.content.library.item.html @@ -0,0 +1,1088 @@ + + + + + + + com.vmware.content.library.item package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.content.library.item package

+
+

Submodules

+
+
+

com.vmware.content.library.item.downloadsession_client module

+

The Content Library Item Download Session module provides classes and classes +for downloading files in a session.

+
+
+class com.vmware.content.library.item.downloadsession_client.File(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The File class provides methods for accessing files within a download +session.

+

After a download session is created against a library item, the File +class can be used to retrieve all downloadable content within the library +item. Since the content may not be available immediately in a downloadable +form on the server side, the client will have to prepare the file and wait +for the file status to become File.PrepareStatus.PREPARED.

+

See com.vmware.content.library.item_client.DownloadSession.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EndpointType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The File.EndpointType class defines the types of endpoints used to +download the file.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EndpointType instance.

+
+
+
+
+DIRECT = EndpointType(string='DIRECT')
+

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.

+
+ +
+
+HTTPS = EndpointType(string='HTTPS')
+

An https download endpoint.

+
+ +
+ +
+
+class Info(name=None, size=None, bytes_transferred=None, status=None, download_endpoint=None, checksum_info=None, error_message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The File.Info class defines the downloaded file.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the file.

    • +

  • size (long or None) – The file size, in bytes. +This attribute may not be available immediately. It is guaranteed +to be set when the client finishes downloading the file.

    • +

  • bytes_transferred (long) – The number of bytes that have been transferred by the server so far +for making this file prepared for download. This value may stay at +zero till the client starts downloading the file.

    • +

  • status (File.PrepareStatus) – The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING, +PREPARED, ERROR) of the file.

    • +

  • download_endpoint (com.vmware.content.library.item_client.TransferEndpoint or None) – Endpoint at which the file is available for download. The value is +valid only when the File.Info.status is +File.PrepareStatus.PREPARED. +This attribute won’t be set until the file status is +File.PrepareStatus.PREPARED.

    • +

  • checksum_info (com.vmware.content.library.item_client.File.ChecksumInfo or None) – The checksum information of the file. When the download is +complete, you can retrieve the checksum from the File.get() +method to verify the checksum for the downloaded file. +The checksum is always calculated for the downloaded file, but this +attribute won’t be set until the download is complete.

    • +

  • error_message (com.vmware.vapi.std_client.LocalizableMessage or None) – Error message for a failed preparation when the prepare status is +File.PrepareStatus.ERROR. +This attribute won’t be set unless there was an error with the file +transfer.

    • +
+
+
+
+ +
+
+class PrepareStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The File.PrepareStatus class defines the state of the file in +preparation for download.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PrepareStatus instance.

+
+
+
+
+ERROR = PrepareStatus(string='ERROR')
+

Prepare failed.

+
+ +
+
+PREPARED = PrepareStatus(string='PREPARED')
+

Prepare succeeded. The file is ready for download.

+
+ +
+
+PREPARE_REQUESTED = PrepareStatus(string='PREPARE_REQUESTED')
+

A prepare has been requested, however the server hasn’t started the +preparation yet.

+
+ +
+
+PREPARING = PrepareStatus(string='PREPARING')
+

A prepare has been requested and the file is in the process of being +prepared.

+
+ +
+
+UNPREPARED = PrepareStatus(string='UNPREPARED')
+

The file hasn’t been requested for preparation.

+
+ +
+ +
+
+get(download_session_id, file_name)
+

Retrieves file download information for a specific file.

+
+
Parameters
+
    +

  • download_session_id (str) – Identifier of the download session. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

    • +

  • file_name (str) – Name of the file requested.

    • +
+
+
Return type
+

File.Info

+
+
Returns
+

The File.Info instance containing the status of the file +and its download link if available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the download session associated with download_session_id +does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if there is no file with the specified file_name.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+list(download_session_id)
+

Lists the information of all the files in the library item associated +with the download session.

+
+
Parameters
+

download_session_id (str) – Identifier of the download session. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

+
+
Return type
+

list of File.Info

+
+
Returns
+

The list of File.Info instances.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the download session associated with download_session_id +doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+prepare(download_session_id, file_name, endpoint_type=None)
+

Requests a file to be prepared for download.

+
+
Parameters
+
    +

  • download_session_id (str) – Identifier of the download session. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.DownloadSession.

    • +

  • file_name (str) – Name of the file requested for download.

    • +

  • endpoint_type (File.EndpointType or None) – Endpoint type request, one of HTTPS, DIRECT. This will determine +the type of the File.Info.download_endpoint that is +generated when the file is prepared. The +File.EndpointType.DIRECT is only available to users who +have the ContentLibrary.ReadStorage privilege. +If not specified the default is File.EndpointType.HTTPS.

    • +
+
+
Return type
+

File.Info

+
+
Returns
+

File information containing the status of the request and the +download link to the file.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the download session does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if there is no file with the specified file_name.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the the download session wasn’t created with the +ContentLibrary.ReadStorage privilege and the caller requested a +File.EndpointType.DIRECT endpoint type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item.downloadsession_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.content.library.item.updatesession_client module

+

The Content Library Item Update Session module provides classes and classes for +updating files in a session.

+
+
+class com.vmware.content.library.item.updatesession_client.CertificateInfo(issuer=None, subject=None, self_signed=None, x509=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CertificateInfo class contains information about the public key +certificate used to sign the content. This class was added in vSphere API +6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • issuer (str) – Certificate issuer. For example: /C=US/ST=California/L=Palo +Alto/O=VMware, Inc. This attribute was added in vSphere API 6.8.

    • +

  • subject (str) – Certificate subject. For example: +C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC +Avamar/CN=EMC Corporation. This attribute was added in vSphere API +6.8.

    • +

  • self_signed (bool) – Whether the certificate is self-signed. This attribute was added in +vSphere API 6.8.

    • +

  • x509 (str) – The X509 representation of the certificate. This attribute was +added in vSphere API 6.8.

    • +
+
+
+
+ +
+
+class com.vmware.content.library.item.updatesession_client.File(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The File class provides methods for accessing files within an update +session.

+

After an update session is created against a library item, the File +class can be used to make changes to the underlying library item metadata +as well as the content of the files. The following changes can be made:

+
    +

  • deleting an existing file within the library item. This deletes both the +metadata and the content.

    • +

  • updating an existing file with new content.

    • +

  • adding a new file to the library item.

    • +
+

The above changes are not applied or visible until the session is +completed. See +com.vmware.content.library.item_client.UpdateSession.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class AddSpec(name=None, source_type=None, source_endpoint=None, size=None, checksum_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The File.AddSpec class describes the properties of the file to be +uploaded.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the file being uploaded.

    • +

  • source_type (File.SourceType) – The source type (NONE, PUSH, PULL) from which the file content will +be retrieved.

    • +

  • source_endpoint (com.vmware.content.library.item_client.TransferEndpoint) – Location from which the Content Library Service will fetch the +file, rather than requiring a client to upload the file. +This attribute is optional and it is only relevant when the value +of sourceType is File.SourceType.PULL.

    • +

  • size (long or None) – The file size, in bytes. +If None, the server will not verify it received the correct size.

    • +

  • checksum_info (com.vmware.content.library.item_client.File.ChecksumInfo or None) – The checksum of the file. If specified, the server will verify the +checksum once the file is received. If there is a mismatch, the +upload will fail. For ova files, this value should not be set. +If None, the server will not verify the checksum.

    • +
+
+
+
+ +
+
+class Info(name=None, source_type=None, size=None, checksum_info=None, source_endpoint=None, upload_endpoint=None, bytes_transferred=None, status=None, error_message=None, keep_in_storage=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The File.Info class defines the uploaded file.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The File.SourceType class defines how the file content is retrieved.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+NONE = SourceType(string='NONE')
+

No source type has been requested.

+
+ +
+
+PULL = SourceType(string='PULL')
+

The server is pulling content from a URL. The URL scheme can be http, +https, file, or ds.

+
+ +
+
+PUSH = SourceType(string='PUSH')
+

The client is uploading content using HTTP(S) PUT requests.

+
+ +
+ +
+
+class ValidationError(name=None, error_message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The File.ValidationError class defines the validation error of a file +in the session.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class ValidationResult(has_errors=None, missing_files=None, invalid_files=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The File.ValidationResult class defines the result of validating the +files in the session.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • has_errors (bool) – Whether the validation was succesful or not. In case of errors, the +File.ValidationResult.missing_files and +File.ValidationResult.invalid_files will contain at least +one entry.

    • +

  • missing_files (set of str) – A set containing the names of the files that are required +but the client hasn’t added.

    • +

  • invalid_files (list of File.ValidationError) – A list containing the files that have been identified as +invalid and details about the error.

    • +
+
+
+
+ +
+
+add(update_session_id, file_spec)
+

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 +server will pull from the provided source endpoint. If a file with the +same name already exists in this session, this method will be used to +update the content of the existing file.

+

When importing a file directly from storage, where the source endpoint +is a file or datastore URI, you will need to have the +ContentLibrary.ReadStorage privilege on the library item. If the file +is located in the same directory as the library storage backing folder, +the server will move the file instead of copying it, thereby allowing +instantaneous import of files for efficient backup and restore +scenarios. In all other cases, a copy is performed rather than a move.

+
+
Parameters
+
    +

  • update_session_id (str) – Identifier of the update session to be modified. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

    • +

  • file_spec (File.AddSpec) – Specification for the file that needs to be added or updated. This +includes whether the client wants to push the content or have the +server pull it.

    • +
+
+
Return type
+

File.Info

+
+
Returns
+

An File.Info class containing upload links as well as +server side state tracking the transfer of the file.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the file_spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller doesn’t have ContentLibrary.ReadStorage privilege on +the library item of the update session and source type +File.SourceType.PULL is requested for a file or datastore +source endpoint (that is, not HTTP or HTTPs based endpoint).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the content of the library item associated with the update +session has been deleted from the storage backings (see +LibraryModel#storageBackings) associated with it.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if metadata files such as manifest and certificate file are added +after the OVF descriptor file. This is applicable to update +sessions with library item type OVF only. This error was added in +vSphere 6.8.0.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+get(update_session_id, file_name)
+

Retrieves information about a specific file in the snapshot of the +library item at the time when the update session was created.

+
+
Parameters
+
    +

  • update_session_id (str) – Identifier of the update session. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

    • +

  • file_name (str) – Name of the file.

    • +
+
+
Return type
+

File.Info

+
+
Returns
+

Information about the file.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the file doesn’t exist in the library item associated with the +update session.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+list(update_session_id)
+

Lists all files in the library item associated with the update session.

+
+
Parameters
+

update_session_id (str) – Identifier of the update session. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Return type
+

list of File.Info

+
+
Returns
+

The list of the files in the library item associated with +the update session. This list may be empty if the caller +has removed all the files as part of this session (in which case +completing the update session will result in an empty library +item).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+remove(update_session_id, file_name)
+

Requests a file to be removed. The file will only be effectively +removed when the update session is completed.

+
+
Parameters
+
    +

  • update_session_id (str) – Identifier of the update session. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

    • +

  • file_name (str) – Name of the file to be removed.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the update session doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the file doesn’t exist in the library item associated with the +update session.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+
+validate(update_session_id)
+

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 +File.ValidationResult.missing_files set. The user can add the +missing files and try re-validating. For other type of errors, +File.ValidationResult.invalid_files will contain the list of +invalid files.

+
+
Parameters
+

update_session_id (str) – Identifier of the update session to validate. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.UpdateSession.

+
+
Return type
+

File.ValidationResult

+
+
Returns
+

A validation result containing missing files or invalid files and +the reason why they are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no update session with the given identifier exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update session is not in the +com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE +state, or if some of the files that will be uploaded by the client +aren’t received correctly.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Anonymous.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content.library.item.updatesession_client.PreviewInfo(state=None, certificate_info=None, warnings=None, cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PreviewInfo class contains information about the files being +uploaded in the update session. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (PreviewInfo.State) – Indicates the state of the preview of the update session. This +attribute was added in vSphere API 6.8.

    • +

  • certificate_info (CertificateInfo or None) – The certificate information of the signed update session content. +This attribute was added in vSphere API 6.8. +This attribute is None if the update session content is not signed.

    • +

  • warnings (list of PreviewWarningInfo) – The list of warnings raised for this update session. Any warning +which is not ignored by the client will, by default, fail the +update session during session complete operation. This attribute +was added in vSphere API 6.8. +This attribute is optional and it is only relevant when the value +of state is PreviewInfo.State.AVAILABLE.

    • +

  • cert_chain (list of str or None) – Certificate chain in base64 format. This attribute was added in +vSphere API 7.0.3.0. +This attribute is None if the update session content is not signed.

    • +
+
+
+
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The PreviewInfo.State class defines the state of the update session’s +preview. This enumeration was added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+AVAILABLE = State(string='AVAILABLE')
+

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 +class attribute was added in vSphere API 6.8.

+
+ +
+
+NOT_APPLICABLE = State(string='NOT_APPLICABLE')
+

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 +6.8.

+
+ +
+
+PREPARING = State(string='PREPARING')
+

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 +type, this state indicates that the OVF descriptor file is currently being +uploaded. This class attribute was added in vSphere API 6.8.

+
+ +
+
+UNAVAILABLE = State(string='UNAVAILABLE')
+

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 +this case the state will transition to PREPARING. This class attribute +was added in vSphere API 6.8.

+
+ +
+ +
+ +
+
+class com.vmware.content.library.item.updatesession_client.PreviewWarningInfo(type=None, message=None, ignored=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PreviewWarningInfo class provides information about the warnings +which are raised during the update session preview. This class was added in +vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (WarningType) – The warning type raised during preview of the update session. This +attribute was added in vSphere API 6.8.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The message specifying more details about the warning. This +attribute was added in vSphere API 6.8.

    • +

  • ignored (bool) – Indicates if this warning will be ignored during session complete +operation. This attribute was added in vSphere API 6.8.

    • +
+
+
+
+ +
+
+class com.vmware.content.library.item.updatesession_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.content.library.item.updatesession_client.WarningBehavior(type=None, ignored=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The WarningBehavior class defines the session behavior if the warning +is raised during the update session. This class was added in vSphere API +6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (WarningType) – The warning type which may be raised during the update session. +This attribute was added in vSphere API 6.8.

    • +

  • ignored (bool) – Indicates if this warning will be ignored during session complete +operation. This attribute was added in vSphere API 6.8.

    • +
+
+
+
+ +
+
+class com.vmware.content.library.item.updatesession_client.WarningType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The WarningType class defines the warnings which can be raised during +the update session. This enumeration was added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the WarningType instance.

+
+
+
+
+EXPIRED_CERTIFICATE = WarningType(string='EXPIRED_CERTIFICATE')
+

The certificate used for signing the content is expired. This class +attribute was added in vSphere API 6.8.

+
+ +
+
+NOT_YET_VALID_CERTIFICATE = WarningType(string='NOT_YET_VALID_CERTIFICATE')
+

The certificate used for signing the content is not yet valid. This class +attribute was added in vSphere API 6.8.

+
+ +
+
+SELF_SIGNED_CERTIFICATE = WarningType(string='SELF_SIGNED_CERTIFICATE')
+

The certificate used for signing the content is self-signed. This class +attribute was added in vSphere API 6.8.

+
+ +
+
+UNTRUSTED_CERTIFICATE = WarningType(string='UNTRUSTED_CERTIFICATE')
+

The certificate used for signing the content is not trusted. This class +attribute was added in vSphere API 6.8.

+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.content.type.html b/vsphere/8.0.2.0/com.vmware.content.type.html new file mode 100644 index 00000000..4f8b1eb2 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.content.type.html @@ -0,0 +1,531 @@ + + + + + + + com.vmware.content.type package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.content.type package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.content.type.ovf_client module

+
+
+class com.vmware.content.type.ovf_client.Cpu(num_cpus=None, reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide the CPU information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • num_cpus (long) – number of CPUs

    • +

  • reservation (long or None) – reservation in MHz +It is optional to set a CPU reservation.

    • +

  • limit (long or None) – CPU limit in MHz +Is is optional to set a CPU limit.

    • +

  • shares (long or None) – CPU shares +It is optional to specify CPU shares.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.Disk(name=None, disk_capacity=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide the disk information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the disk

    • +

  • disk_capacity (long) – Capacity of the disk in megabytes

    • +

  • storage_policy (com.vmware.content.type.ovf.policy_client.StoragePolicy or None) –

    Storage policy of the disk.

    +

    It is a reference to the storage policy group. +It is not required that storage policy be specified.

    +

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.DiskController(name=None, type=None, sub_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide the disk controller information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the disk controller

    • +

  • type (str or None) – Disk controller type: DiskControllerType.IDE.SATA.SCSI; +It is optional to specify a disk controller type.

    • +

  • sub_type (str or None) – Disk controller sub type: DiskControllerSubType +It is optional to specify a disk controller subtype.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.Drive(name=None, type=None, sub_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide the drive information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the drive

    • +

  • type (str or None) – Drive type +It is optional to specify a drive type.

    • +

  • sub_type (str or None) – Drive sub type +It is optional to specify a drive subtype.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.Floppy(name=None, connected=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide the floppy information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the floppy

    • +

  • connected (bool or None) – True if floppy is connected +It is optional to specify if a floppy is connected.

    • +

  • type (str or None) – Floppy type +It is optional to specify the type of floppy drive.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.Memory(size=None, reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide the memory information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size (long) – memory size in MB

    • +

  • reservation (long or None) – memory reservation in MB +It is not required that memory reservation be specified.

    • +

  • limit (long or None) – memory limit in MB +It is not required that memory limit be specified.

    • +

  • shares (long or None) – memory shares +It is not required that memory shares be specified.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.Network(name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide network information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the network

    • +

  • description (str or None) – Description of the network +Networks do not require a description.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.Nic(name=None, network_name=None, mac_address=None, start_connected=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide NIC information in a VM template

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of NIC

    • +

  • network_name (str or None) – Name of the network that this NIC connects to +It is not required that network name be specified.

    • +

  • mac_address (str or None) – Mac address of this NIC +It is not required that MAC address be specified.

    • +

  • start_connected (bool or None) – True if this nic will be connected on start. +It is not required that whether the NIC is connected be specified.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.OvfTemplate(id=None, vm_count=None, version=None, library_id_parent=None, is_vapp_template=None, vm_template=None, vapp_template=None, networks=None, storage_policy_groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provides extra information about a library item of type “ovf”.

+

An OVF library item is the basic building block for instantiating virtual +machines from content library. It may contain one or multiple virtual +machine templates. This structure provides a rich view of the virtual +machines within the ovf container as well as information about to the ovf +descriptor associated with the library item

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Library item id. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item.

    • +

  • vm_count (long) – Number of virtual machines in the the ovf template.

    • +

  • version (str) –

    A version number indicating the generation of the OvfTemplate

    +

    This value is incremented every time OvfTemplate changes.

    +

    • +

  • library_id_parent (str) – The identifier of the +com.vmware.content_client.LibraryModel to which this item +belongs. This is used to set the parent of the ovf template for +permission propagation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

    • +

  • is_vapp_template (bool) – True if this is a vApp template, otherwise this is a VM template.

    • +

  • vm_template (VmTemplate or None) – The Vitrual Machine if this is a VM template +An OVF template does not require a VM template.

    • +

  • vapp_template (VAppTemplate or None) – The root VApp template in this OVF template if this is a vApp +template +An OVF template does not require a vApp template.

    • +

  • networks (list of Network) – networks in this OVF template

    • +

  • storage_policy_groups (list of com.vmware.content.type.ovf.policy_client.StoragePolicyGroup or None) – Storage policy groups for disks, virtual machines and/or virtual +machine collections. +An OVF template does not require policies.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.USBController(type=None, auto_connect=None, ehci_pci_slot_number=None, pci_slot_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide USB controller information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (str or None) – USBControllerType.EHCI (USB 2.0), XHCI (USB 3.0) +A template is not required to specify the USB type.

    • +

  • auto_connect (bool or None) – True if the USB controller is connected automatically +A template is not required to specify if auto connect.

    • +

  • ehci_pci_slot_number (long or None) – ehci.pci slot number +A template is not required to specify the ehci.pci slot number.

    • +

  • pci_slot_number (long or None) – pci slot number +A template is not required to specify the pci slot number.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.VAppTemplate(vapp_name=None, vm_templates=None, storage_policies=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide information for vApp template in an OVF template file.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vapp_name (str or None) – Name of the vApp template +vApp templates do not require a name.

    • +

  • vm_templates (list of VmTemplate or None) – Vitrual Machines in this vApp template +vApp templates do not require a list of VM templates.

    • +

  • storage_policies (list of com.vmware.content.type.ovf.policy_client.StoragePolicy or None) – Storage policies of the vApp template. +vApp templates do not require a list of storage policies.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.VideoCard(render_type=None, video_ram_size=None, graphics_memory_size=None, enable3d=None, num_displays=None, use_auto_detect=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide video card information in a template VM.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • render_type (str or None) – Render type +A template is not required to specify the render type.

    • +

  • video_ram_size (long or None) – video RAM size in KB +A template is not required to specify the video RAM.

    • +

  • graphics_memory_size (long or None) – graphics memory size in KB +A template is not required to specify the amount of graphics +memory.

    • +

  • enable3d (bool or None) – True if 3D is enabled +A template is not required to specify if 3D is enabled.

    • +

  • num_displays (long or None) – number of displayes +A template is not required to specify the number of displays.

    • +

  • use_auto_detect (bool or None) – True if use auto detect +A template is not required to specify use auto dectect.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf_client.VmTemplate(vm_name=None, os_type=None, os_description=None, cpu=None, memory=None, disks=None, nics=None, video_cards=None, drives=None, floppies=None, disk_controllers=None, usb_controllers=None, storage_policies=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide template VM information in an OVF template (see OvfTemplate#type). +The template VM provide the information about the operation system, CPU, +memory, disks and NICs.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_name (str) – Name of the VM

    • +

  • os_type (str or None) – OS type of the VM +A VM template is not required to specify an OS.

    • +

  • os_description (str or None) – OS description +A VM template is not required to specify an OS.

    • +

  • cpu (Cpu or None) – CPU information of the VM +A VM template is not required to specify a CPU.

    • +

  • memory (Memory or None) – memory information of the VM +A VM template is not required to specify memory.

    • +

  • disks (list of Disk or None) – All hard disks on the VM +A VM template is not required to specify a list of disks.

    • +

  • nics (list of Nic or None) – All NICs on the VM +A VM template is not required to specify a list of network +interfaces.

    • +

  • video_cards (list of VideoCard or None) – Video cards of the VM +A VM template is not required to specify a list of video cards.

    • +

  • drives (list of Drive or None) – CD / DVD drives of the VM +A VM template is not required to specify a list of drives.

    • +

  • floppies (list of Floppy or None) – floppy drives of the VM +A VM template is not required to specify a list of floppy drives.

    • +

  • disk_controllers (list of DiskController or None) – Disk Controllers +A VM template is not required to specify a list of disk +controllers.

    • +

  • usb_controllers (list of USBController or None) – USB Controllers +A VM template is not required to specify a list of USB controllers.

    • +

  • storage_policies (list of com.vmware.content.type.ovf.policy_client.StoragePolicy or None) – Storage policies of the VM. +A VM template is not required to specify a list of storage +policies.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.content.type.ovf.html b/vsphere/8.0.2.0/com.vmware.content.type.ovf.html new file mode 100644 index 00000000..707b209f --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.content.type.ovf.html @@ -0,0 +1,191 @@ + + + + + + + com.vmware.content.type.ovf package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.content.type.ovf package

+
+

Submodules

+
+
+

com.vmware.content.type.ovf.policy_client module

+
+
+class com.vmware.content.type.ovf.policy_client.StoragePolicy(group_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide information of the membership of a particular storage policy group.

+

It is valid for disk, virtual machine or virtual machine collection.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

group_id (str) – Id reference of the particular storage policy group.

+
+
+
+ +
+
+class com.vmware.content.type.ovf.policy_client.StoragePolicyGroup(id=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provide information of storage policy for a group of disks, virtual +machines and/or virtual machine collections.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Id of the policy

    • +

  • name (str) – Name of the policy

    • +

  • description (str or None) – Description of the policy +Description is not required.

    • +
+
+
+
+ +
+
+class com.vmware.content.type.ovf.policy_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.hcl.html b/vsphere/8.0.2.0/com.vmware.esx.hcl.html new file mode 100644 index 00000000..56bf1fdb --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.hcl.html @@ -0,0 +1,595 @@ + + + + + + + com.vmware.esx.hcl package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.hcl package

+
+

Submodules

+
+
+

com.vmware.esx.hcl.hosts_client module

+
+
+class com.vmware.esx.hcl.hosts_client.CompatibilityReleases(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

This class provides methods to list available releases for generating +compatibility report for a specific ESXi host.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EsxiCompatibilityReleases(current_compatibility_release=None, newer_compatibility_releases=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReleases.EsxiCompatibilityReleases class contains +attributes that describe available releases for generating compatibility +report for a specific ESXi host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • current_compatibility_release (str) –

    The current release of the ESXi, which also can be checked for +compatibility.

    +

    The information for the release does not include patch information.

    +

    • +

  • newer_compatibility_releases (list of str) – The available ESXi releases, greater than the current one, than can +be checked for compatibility.

    • +

  • notifications (com.vmware.esx.hcl_client.Notifications) – Notifications returned by the operation.

    • +
+
+
+
+ +
+
+list(host)
+

Lists the locally available ESXi releases for a given host that can be +used to generate a compatiblity report. Each host has its own list of +supported releases depending on its current release.

+
+
Parameters
+

host (str) – Contains the MoID identifying the ESXi host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

CompatibilityReleases.EsxiCompatibilityReleases

+
+
Returns
+

Available releases for compatibility for a specified host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +If there is some internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if there is no compatibility data on the vCenter executing the +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no host with the given MoID can be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the provided host is not supported.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the vCenter this API is executed on is not part of the Customer +Experience Improvement Program (CEIP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.HardwareCompatibility.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.hcl.hosts_client.CompatibilityReport(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

This class provides methods to generate hardware compatibility report for a +given ESXi host against a specific ESXi release.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BiosConstraint(bios=None, notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReport.BiosConstraint class contains attributes that +describe the BIOS that is supported for the given server and ESXi release.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class DeviceConstraint(driver=None, firmware=None, notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReport.DeviceConstraint class contains attributes +that describe pair of driver and firmware that are supported for a given +PCI device and ESXi release.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class DeviceHclInfo(compatibility=None, device=None, device_constraints=None, supported_releases=None, vcg_link=None, notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReport.DeviceHclInfo class contains attributes that +describe a PCI device of a given ESXi host and its compatibility +information.

+

If there are multiple PCI devices of the same type on the host each one +will be listed in separate instance of this class.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatibility (com.vmware.esx.hcl_client.CompatibilityStatus) – Indicates compatibility status of the PCI device.

    • +

  • device (com.vmware.esx.hcl_client.PCIDevice) – Information about the PCI device.

    • +

  • device_constraints (list of CompatibilityReport.DeviceConstraint or None) – Lists the constraints the target ESXi release has for this PCI +device +If None no constraints are present as PCI device is either not +compatible or compatibility information is not found.

    • +

  • supported_releases (list of str or None) – Provides information about supported releases for this device. +If None device is compatible with the given target release.

    • +

  • vcg_link (str or None) – Provides link to the VMware Compatibility Guide for further +information on the compatibility. +If None there is no VMware Compatibility link available as this is +device used by VSAN.

    • +

  • notes (list of com.vmware.vapi.std_client.LocalizableMessage or None) – Information that needs to be taken into account when considering +this device hcl. +Only set if there is any information reported.

    • +
+
+
+
+ +
+
+class HclReport(host=None, target_release=None, server_hcl=None, devices_hcl=None, generated_at=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReport.HclReport represents the hardware +compatibility report generated for a specific host and target ESXi release.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – FQDN identifying the ESXi host that the report refers to.

    • +

  • target_release (str) – Indicates for which ESXi release the report is generated.

    • +

  • server_hcl (CompatibilityReport.ServerHclInfo) – Lists compatibility information for the ESXi’s server part.

    • +

  • devices_hcl (list of CompatibilityReport.DeviceHclInfo or None) – Lists compatibility information for discoverable PCI devices of the +host. +If None the server is not compatible with the requested release and +the PCI devices cannot be checked.

    • +

  • generated_at (datetime.datetime) – Specifies the time the report was generated.

    • +

  • notifications (com.vmware.esx.hcl_client.Notifications) – Notifications returned by the operation.

    • +
+
+
+
+ +
+
+class Result(report=None, identifier=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CompatibilityReport.Result class contains the result of hardware +compatibility report creation operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • report (CompatibilityReport.HclReport) – The hardware compatibility report.

    • +

  • identifier (str or None) –

    The identifier of the compatibility report.

    +

    com.vmware.esx.hcl_client.Reports.get() provides location +where a file based report based on the +CompatibilityReport.HclReport can be downloaded using this +identifier. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.hcl.resources.CompatibilityReport. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.hcl.resources.CompatibilityReport. +None in case of error reported in +CompatibilityReport.HclReport.notifications.

    +

    • +
+
+
+
+ +
+
+class ServerCompatibility(bios_constraints=None, cpu_series=None, supported_releases=None, vcg_link=None, notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReport.ServerCompatibility class contains attributes +that provide the compatibility information for a server model, cpu and +BIOS.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bios_constraints (list of CompatibilityReport.BiosConstraint or None) – Lists the BIOS constraints that the target ESXi release has for +this server. +If None no constraints are present as server is either not +compatible or compatibility information is not found.

    • +

  • cpu_series (str) – The CPU series name.

    • +

  • supported_releases (list of str or None) – Provides information about supported releases for this entry. +If None server is compatible with the given target release.

    • +

  • vcg_link (str) – Provides link to the VMware Compatibility Guide for further +information on the compatibility.

    • +

  • notes (list of com.vmware.vapi.std_client.LocalizableMessage or None) – Information that needs to be taken into account when considering +this server hardware compatibility. +Only set if there is any information reported.

    • +
+
+
+
+ +
+
+class ServerHclInfo(server=None, matches=None, model_compatibility=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This CompatibilityReport.ServerHclInfo class contains attributes that +describe the server of a ESXi host and its compatibility information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Spec(release=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CompatibilityReport.Spec class contains attributes to describe the +input configuration for an ESXi’s compatibility report generation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

release (str) – A target ESXi release which will be used to generate a +compatibility report. Releases that can be used to generate report +can be found using CompatibilityReleases.list()

+
+
+
+ +
+
+create_task(host, spec=None)
+

Generates hardware compatibility report for a specified ESXi host +against specific ESXi release.

+

The result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+
    +

  • host (str) – Contains the MoID identifying the ESXi host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (CompatibilityReport.Spec or None) – Specifies the input parameters for generating compatibility report. +If None host compatibility will be checked against the current +release of the ESXi.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no host with the given MoID can be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the provided host is not supported.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the vCenter this API is executed on is not part of the Customer +Experience Improvement Program (CEIP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if there is no compatibility data on the vCenter executing the +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
+
+ +
+
+get(host)
+

Returns the last generated hardware compatibility report for the given +host.

+
+
Parameters
+

host (str) – The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

CompatibilityReport.Result

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no report generated for the given host. This operation +does not check if the host id is valid or it exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the vCenter this API is executed on is not part of the Customer +Experience Improvement Program (CEIP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.HardwareCompatibility.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.hcl.hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.hosts.html b/vsphere/8.0.2.0/com.vmware.esx.hosts.html new file mode 100644 index 00000000..292157a9 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.hosts.html @@ -0,0 +1,238 @@ + + + + + + + com.vmware.esx.hosts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.hosts package

+
+

Submodules

+
+
+

com.vmware.esx.hosts.software_client module

+

The com.vmware.esx.hosts.software_client module provides classes to get +information about current software on ESX.

+
+
+class com.vmware.esx.hosts.software_client.InstalledComponents(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The InstalledComponents class provides methods to get installed list of +components.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class InstalledComponentInfo(display_name=None, version=None, display_version=None, platforms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InstalledComponents.InstalledComponentInfo class contains +attributes that describe the installed component on the host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the component.

    • +

  • version (str) – Version of the installed component

    • +

  • display_version (str) – Human readable version of the component.

    • +

  • platforms (set of str) – Platforms the component belongs to. Example: host, vmdpu0, vmdpu1, +… This attribute was added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+list(host)
+

Returns the installed components on the host.

+
+
Parameters
+

host (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

dict of str and InstalledComponents.InstalledComponentInfo

+
+
Returns
+

The components installed on the host. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.hosts.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.hosts.software_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.html b/vsphere/8.0.2.0/com.vmware.esx.html new file mode 100644 index 00000000..35494624 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.html @@ -0,0 +1,3326 @@ + + + + + + + com.vmware.esx package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.hcl_client module

+

The com.vmware.esx.hcl_client module provides classes to query the hardware +compatibility for an ESXi or a cluster.

+
+
+class com.vmware.esx.hcl_client.CompatibilityData(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

This class provides methods to update the local compatibility data residing +on the vCenter Appliance or to get information about the said data. The +information in the data is generic VMware compatibility information for +servers and devices.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Status(updated_at=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CompatibilityData.Status class contains attributes to describe the +information available for the compatibility data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • updated_at (datetime.datetime) – Indicates when the data was last updated.

    • +

  • notifications (Notifications) – Notifications returned by the operation.

    • +
+
+
+
+ +
+
+get()
+

Provides information about the compatibility data located on the +vCenter Appliance.

+
+
Return type
+

CompatibilityData.Status

+
+
Returns
+

Information about the compatibility data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if there is no compatibility data on the vCenter executing the +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the vCenter this API is executed on is not part of the Customer +Experience Improvement Program (CEIP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.HardwareCompatibility.Read.

    • +
+
+
+
+ +
+
+update_task()
+

Replaces the local compatibility data with the latest version found +from VMware official source.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if there is compatibility data update in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the vCenter this API is executed on is not part of the Customer +Experience Improvement Program (CEIP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
+
+ +
+ +
+
+class com.vmware.esx.hcl_client.CompatibilityStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CompatibilityStatus class defines compatibility status of a given +server or PCI device against a specific release of ESXi.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CompatibilityStatus instance.

+
+
+
+
+CERTIFIED = CompatibilityStatus(string='CERTIFIED')
+

When given hardware is certified for the specified ESXi release. Its +software is also validated and it is also certified.

+
+ +
+
+COMPATIBLE = CompatibilityStatus(string='COMPATIBLE')
+

When given hardware is certified for the specified ESXi release but no +validation of the software of this hardware is performed.

+
+ +
+
+INCOMPATIBLE = CompatibilityStatus(string='INCOMPATIBLE')
+

When given hardware is not certified for the specified ESXi release.

+
+ +
+
+NOT_CERTIFIED = CompatibilityStatus(string='NOT_CERTIFIED')
+

When given hardware is certified for the specified ESXi release. Its +software is also validated and it is not certified.

+
+ +
+
+UNAVAILABLE = CompatibilityStatus(string='UNAVAILABLE')
+

When there is no information about specified hardware.

+
+ +
+ +
+
+class com.vmware.esx.hcl_client.Driver(name=None, version=None, vendor=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Driver class contains attributes describing information about a +driver.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the driver.

    • +

  • version (str) – The version of the driver.

    • +

  • vendor (str or None) – The vendor that produced the driver. +If None vendor is unknown.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hcl_client.Firmware(version=None, vendor=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Firmware class contains attributes describing information about a +firmware.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – The version of the firmware.

    • +

  • vendor (str or None) – The vendor that produced the firmware. +If None vendor is unknown.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hcl_client.Notification(id=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class contains attributes to describe any +info/warning/error messages that Tasks can raise.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.esx.hcl_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the task.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. +Only set if an info was reported by the task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. +Only set if an warning was reported by the task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. +Only set if an error was reported by the task.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hcl_client.PCIDevice(pci_address=None, vid=None, did=None, svid=None, ssid=None, vendor=None, model_name=None, class_code=None, sub_class_code=None, driver=None, firmware=None, used_by_vsan=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PCIDevice class contains attributes describing information about a +single PCI device on a host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pci_address (str) – The device’s address in a given ESXi host.

    • +

  • vid (str) – A unique number assigned to each computer hardware device that +helps to identify the chipset manufacturer. For example, Dell, +Broadcom, etc.

    • +

  • did (str) – A unique number that identifies the specific device of the Vendor +(VID).

    • +

  • svid (str) – A unique number that identifies the card manufacturer.

    • +

  • ssid (str) – A unique number that identifies the specific device of Subsystem +Vendor (SVID).

    • +

  • vendor (str) – The name of the vendor.

    • +

  • model_name (str) – The name of the device model.

    • +

  • class_code (str) – Register that specifies the type of function the device performs.

    • +

  • sub_class_code (str) – Register that specifies the specific function the device performs.

    • +

  • driver (Driver) – Currently installed driver used by the device.

    • +

  • firmware (Firmware or None) – Currently installed firmware used by the device. +If None firmware is unknown.

    • +

  • used_by_vsan (bool) – Shows whether the device is part of VSAN cluster or not.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hcl_client.Reports(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

This class provides methods to download information generated from the +hardware compatibility feature residing on the vCenter Appliance.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Location(url=None, report_token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Reports.Location class contains the URI location to download +generated compatibility report, as well as a token required (as a header on +the HTTP GET request) to get the report. The validity of the token is 5 +minutes. After the token expires, any attempt to call the URI with said +token will fail.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • url (str) – Compatibility report download URL.

    • +

  • report_token (Reports.Token) – Information about the token required in the HTTP GET request to +download the compatibility report.

    • +
+
+
+
+ +
+
+class Token(token=None, expiry=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Reports.Token class contains information about the token required +to be passed in the HTTP header in the HTTP GET request to generate the +report.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • token (str) – A one-time, short-lived token required in the HTTP header of the +request to the url. This token needs to be passed in as a header +with the name “session-id”.

    • +

  • expiry (datetime.datetime) – Expiry time of the token

    • +
+
+
+
+ +
+
+get(report)
+

Returns the location Reports.Location information for +downloading a compatibility report.

+
+
Parameters
+

report (str) – identifier of hardware compatiblity report to be downloaded. +The parameter must be an identifier for the resource type: +com.vmware.esx.hcl.resources.CompatibilityReport.

+
+
Return type
+

Reports.Location

+
+
Returns
+

Reports.Location class which includes the URI to file, short +lived token and expiry of the token in the +Reports.Location object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no report for the given id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the vCenter this API is executed on is not part of the Customer +Experience Improvement Program (CEIP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.HardwareCompatibility.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.hcl_client.Server(model_name=None, vendor=None, cpu_series=None, cpu_features=None, bios=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Server class contains attributes describing information about a +server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • model_name (str) – The name of the server model (for example, “PowerEdge R740xd”).

    • +

  • vendor (str) – The name of the vendor (for example, “Dell”).

    • +

  • cpu_series (str) –

    The CPU series name (for example, “Intel Xeon Gold 6100/5100, +Silver 4100, Bronze 3100 (Skylake-SP) Series”).

    +

    Note: This attribute is initialized with the CPU model name; +it’s updated to the actual CPU series later, based on recognizing +one of the CPU series the server hardware is certified with in the +VCG.s

    +

    • +

  • cpu_features (str) – The current CPU features.

    • +

  • bios (Firmware) – Currently installed BIOS of the server.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hcl_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.hosts_client module

+

The com.vmware.esx.hosts_client module provides classes to manage ESX host.

+
+
+class com.vmware.esx.hosts_client.AddOnInfo(name=None, version=None, display_name=None, vendor=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOnInfo class contains attributes that describe a specific OEM +customization add-on in the software solution.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the add-on +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.hosts.add_on. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.hosts.add_on.

    • +

  • version (str) – Version of the add-on

    • +

  • display_name (str) – Display name of the OEM add-on.

    • +

  • vendor (str) – Vendor of the OEM add-on.

    • +

  • display_version (str) – Human readable version of the OEM add-on.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.AddOnSpec(name=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOnSpec class contains attributes that describe a specific OEM +customization add-on in the software specification. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the add-on. This attribute was added in vSphere API +7.0.2.0.

    • +

  • version (str) – Version of the add-on. This attribute was added in vSphere API +7.0.2.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.BaseImageInfo(version=None, display_name=None, display_version=None, release_date=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageInfo class contains attributes that describe a specific +ESX base-image in the software solution.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the base-image. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.hosts.base_image. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.hosts.base_image.

    • +

  • display_name (str) – Display name of the base-image.

    • +

  • display_version (str) – Human readable version of the base-image.

    • +

  • release_date (datetime.datetime) – Release date of the base-image.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.BaseImageSpec(version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageSpec class contains attributes that describe a specific +ESX base-image in the software specification. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

version (str) – Version of the base-image. This attribute was added in vSphere API +7.0.2.0.

+
+
+
+ +
+
+class com.vmware.esx.hosts_client.CertificateInfo(ssl_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CertificateInfo Class contains information about the SSL +certificate for a server. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ssl_thumbprint (str) – The SHA thumbprint of the SSL certificate for a server. This +attribute was added in vSphere API 7.0.2.0.

+
+
+
+ +
+
+class com.vmware.esx.hosts_client.ComponentInfo(version=None, display_name=None, display_version=None, vendor=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentInfo class contains attributes that describe a specific +component version in the software solution.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the component.

    • +

  • display_name (str) – Display name of the component.

    • +

  • display_version (str) – Human readable version of the component.

    • +

  • vendor (str) – Vendor of the component.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.HardwareSupportInfo(packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportInfo class contains information to describe the +Hardware Support Package (HSP) in the software solution. This class was +added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

packages (dict of str and HardwareSupportPackageInfo) – Map of Hardware Support Packages (HSPs). The key is the Hardware +Support Manager (HSM) identifier and the value is the specification +detailing the HSP configured for that HSM. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.hosts.hardware_support.manager.

+
+
+
+ +
+
+class com.vmware.esx.hosts_client.HardwareSupportPackageInfo(pkg=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageInfo class contains information to describe +the Hardware Support Package (HSP) configured for a single device or +distinct group of devices (typically the OEM’s, including BIOS and device +firmware). This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pkg (str) – Identifier of Hardware Support Package (HSP) selected. This +attribute was added in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.hosts.hardware_support.package. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.hosts.hardware_support.package.

    • +

  • version (str) – Version of the Hardware Support Package (HSP) selected (e.g. +“20180128.1” or “v42”). This attribute was added in vSphere API +7.0.2.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.HardwareSupportPackageSpec(pkg=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageSpec class contains attributes to describe +the Hardware Support Package (HSP) configured for a single device or +distinct group of devices (typically the OEM’s, including BIOS, device +firmware and OEM-supplied driver or agent components). This class was added +in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pkg (str or None) – Hardware Support Package (HSP) selected. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.hosts.hardware_support.package. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.hosts.hardware_support.package.

    • +

  • version (str or None) – Version of the Hardware Support Package (HSP) selected (e.g. +“20180128.1” or “v42”). This attribute was added in vSphere API +7.0.2.0. +If None, the system will use an empty string as the version.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.HardwareSupportSpec(packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportSpec class contains attributes to describe the +Hardware Support Packages (HSP) included in the software specification. +This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

packages (dict of str and HardwareSupportPackageSpec) – Map of Hardware Support Packages (HSPs). The key is the Hardware +Support Manager (HSM) name and the value is the specification +detailing the HSP configured for that HSM. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.hosts.hardware_support.manager.

+
+
+
+ +
+
+class com.vmware.esx.hosts_client.Notification(id=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class contains attributes to describe any +info/warning/error messages that Tasks can raise. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The notification id. This attribute was added in vSphere API +7.0.2.0.

    • +

  • time (datetime.datetime) – The time the notification was raised/found. This attribute was +added in vSphere API 7.0.2.0.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message. This attribute was added in vSphere API +7.0.2.0.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. This attribute was added in vSphere +API 7.0.2.0. +Only set if there is a resolution available for this +notification.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the task. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. This attribute was added in +vSphere API 7.0.2.0. +Only set if an info was reported by the task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. This attribute was added in +vSphere API 7.0.2.0. +Only set if an warning was reported by the task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. This attribute was added in +vSphere API 7.0.2.0. +Only set if an error was reported by the task.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.Software(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Software class provides methods to get and extract the current +software specification applied to the host. This class was added in vSphere +API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConnectionSpec(auth_type=None, host_credential=None, host=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ConnectionSpec class contains attributes that describe the +specification to be used for connecting to the host during the +Software.get() method. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auth_type (Software.ConnectionSpec.AuthenticationType) – Specifies what type of authentication (USERNAME_PASSWORD, EXISTING) +is to be used when connecting with the host. USERNAME_PASSWORD is +intended to be used when connecting to a host that is not currently +part of the vCenter inventory. EXISTING is intented for hosts that +are in vCenter inventory, in which case, HostServiceTicket will be +used to connect to the host. This attribute was added in vSphere +API 7.0.2.0.

    • +

  • host_credential (Software.HostCredentials) – Specifies the host details to be used during the +Software.get() method. This attribute was added in vSphere +API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of authType is +Software.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD.

    • +

  • host (str) – Specifies the host Managed Object ID to be used during the +Software.get() method. This attribute was added in vSphere +API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of authType is +Software.ConnectionSpec.AuthenticationType.EXISTING.

    • +
+
+
+
+
+class AuthenticationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.ConnectionSpec.AuthenticationType class defines the +possible types of authentication supported when connecting to the host. +This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the AuthenticationType instance.

+
+
+
+
+EXISTING = AuthenticationType(string='EXISTING')
+

Connect to the host using service ticket. Note: This is supported only for +hosts present in the VC inventory. This class attribute was added in +vSphere API 7.0.2.0.

+
+ +
+
+USERNAME_PASSWORD = AuthenticationType(string='USERNAME_PASSWORD')
+

Connect to host using host’s credentials HostCredentials class. This +class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class HostCredentials(host_name=None, user_name=None, password=None, port=None, ssl_thumb_print=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.HostCredentials class contains attributes that describe +the host’s username, password, port number, ssl thumbprint or ssl +certificate to be used when connecting to the host using USERNAME_PASSWORD +option in the AuthenticationType class. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host_name (str) – The IP address or DNS resolvable name of the host. This attribute +was added in vSphere API 7.0.2.0.

    • +

  • user_name (str) – Specifies the username to be used during the Software.get() +method. This attribute was added in vSphere API 7.0.2.0.

    • +

  • password (str) – Specifies the password to be used during the Software.get() +method. This attribute was added in vSphere API 7.0.2.0.

    • +

  • port (long or None) – Specifies the port number of the host to be used during +Software.get() method. This attribute was added in vSphere +API 7.0.2.0. +If None, port number is set to 443.

    • +

  • ssl_thumb_print (str or None) – Specifies the sslThumbPrint of the host to be used during +Software.get() method SHA1 hash of the host’s SSL +certificate. This attribute was added in vSphere API 7.0.2.0. +If None, Software.get() method this operation will throw +UnverifiedPeer with the host provided thumbprint as data.

    • +
+
+
+
+ +
+
+class Info(notifications=None, software_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.Info class contains attributes that describe the current +software information on a host. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • notifications (Notifications) – Notifications returned by the get operation. This attribute was +added in vSphere API 7.0.2.0.

    • +

  • software_info (SoftwareInfo) – Host software information returned by the get operation. This +attribute was added in vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+get(spec)
+

Returns details about the current software specification applied to the +host. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+

spec (Software.ConnectionSpec) – ConnectionSpec connection spec for the host.

+
+
Return type
+

Software.Info

+
+
Returns
+

Info details about the current software specification applied to +the host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the ConnectionSpec.HostCredentials attribute of spec is +invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no ConnectionSpec.HostCredentials#hostName +attribute associated with host id in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the target node cannot be validated by +comparing with the thumbprint provided in +ConnectionSpec.HostCredentials#sslThumbPrint or the full +certificate provided in +ConnectionSpec.HostCredentials#sslCertificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.hosts_client.SoftwareInfo(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SoftwareInfo class contains attributes that describes the software +solution for an ESX host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • base_image (BaseImageInfo) – Base image of the ESX.

    • +

  • add_on (AddOnInfo or None) – OEM customization on top of given base-image. The components in +this customization override the components in the base base-image. +If None, no OEM customization exists.

    • +

  • components (dict of str and (ComponentInfo or None)) – Map of components in an ESX image. The key is the component name +and value is the information about specific version of the +component. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.hosts.component.

    • +

  • solutions (dict of str and SolutionInfo) – Map of software solutions in an ESX image. The key is the solution +name and value is the specification detailing components registered +by that solution. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.hosts.solution.

    • +

  • hardware_support (HardwareSupportInfo or None) – Information about the Hardware Support Packages (HSP) configured. +This attribute was added in vSphere API 7.0.2.0. +If None, no Hardware Support Package (HSP) info exists.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.SoftwareSpec(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SoftwareSpec class contains attributes that describe software +specification for an ESX host. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • base_image (BaseImageSpec) – Base image of the ESX. This attribute was added in vSphere API +7.0.2.0.

    • +

  • add_on (AddOnSpec or None) – OEM customization on top of given base-image. The components in +this customization override the components in the base base-image. +This attribute was added in vSphere API 7.0.2.0. +If None, no OEM customization will be applied.

    • +

  • components ((dict of str and (str or None)) or None) – Additional components which are part of the software specification. +If value is not given for a particular component then version for +that component will be picked from the constraints. These override +the components present in SoftwareSpec.add_on and +SoftwareSpec.base_image. This attribute was added in +vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.hosts.component. +If None, no additional components are present in the software +specification.

    • +

  • solutions ((dict of str and SolutionSpec) or None) – Mapping from solution identifier to the solution specification. The +key is the solution name and the value is the specification +detailing components registered by that solution. This attribute +was added in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.hosts.solution. +If None, no solutions are present in the software specification.

    • +

  • hardware_support (HardwareSupportSpec or None) – Information about the Hardware Support Package (HSP) configured in +the software specification. This attribute was added in vSphere API +7.0.2.0. +If None or empty, no firmware info will be part of the software +specification.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.SolutionComponentSpec(component=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionComponentSpec class contains attributes that describe a +component registered by a software solution. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

component (str) – Identifier of the component. This attribute was added in vSphere +API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.hosts.component. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.hosts.component.

+
+
+
+ +
+
+class com.vmware.esx.hosts_client.SolutionInfo(version=None, display_name=None, components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionInfo class contains attributes that describe solution +registered in the software solution.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the solution.

    • +

  • display_name (str) – Display name of the solution.

    • +

  • components (dict of str and ComponentInfo) – Components registered by the solution. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.hosts.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.hosts.component.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.SolutionSpec(version=None, components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionSpec class contains attributes that describe solution +registered in the software specification. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the solution. This attribute was added in vSphere API +7.0.2.0.

    • +

  • components (list of SolutionComponentSpec) – Components registered by the solution. This attribute was added in +vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings_client module

+

The com.vmware.esx.settings_client module provides classes to manage ESX +settings.

+
+
+class com.vmware.esx.settings_client.AddOnCompliance(status=None, stage_status=None, current=None, target=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOnCompliance class contains information that describe the +compliance of the OEM add-on with respect to the add-on present in the +target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the OEM add-on.

    • +

  • stage_status (StageStatus or None) – Stage status of the OEM add-on. This is only relevant when the +value of AddOnCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • current (AddOnInfo or None) – Current OEM add-on present on the host. +None if OEM add-on is not present on the host.

    • +

  • target (AddOnInfo or None) – Target OEM add-on present in the software specification. +None if OEM add-on is not present in the software specification.

    • +

  • notifications (Notifications) – Notifications describing the compliance result.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.AddOnDetails(display_name=None, vendor=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOnDetails class contains information that provide more details +about the add-on from the depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the OEM add-on.

    • +

  • vendor (str) – Vendor of the OEM add-on.

    • +

  • display_version (str) – Human readable version of the OEM add-on.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.AddOnInfo(details=None, name=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOnInfo class contains information that describe a specific OEM +customization add-on.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • details (AddOnDetails or None) – Details about the add-on. +None if add-on is not present in the depot.

    • +

  • name (str) – Name of the add-on

    • +

  • version (str) – Version of the add-on

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.AddOnSpec(name=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOnSpec class contains attributes that describe a specific OEM +customization add-on.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the add-on

    • +

  • version (str) – Version of the add-on

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.BaseImageCompliance(status=None, stage_status=None, current=None, target=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageCompliance class contains information that describe the +compliance of ESX base image with respect to the base image present in the +target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the base image.

    • +

  • stage_status (StageStatus or None) – Stage status of the base image. This is only relevant when the +value of BaseImageCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • current (BaseImageInfo) – Current base image information on the host.

    • +

  • target (BaseImageInfo) – Target base image information present in the software +specification.

    • +

  • notifications (Notifications) – Notifications describing the compliance result.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.BaseImageDetails(display_name=None, display_version=None, release_date=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageDetails class contains information that provide more +details about the base image from the depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the base image.

    • +

  • display_version (str) – Human readable version of the base image.

    • +

  • release_date (datetime.datetime) – Release date of the base image.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.BaseImageInfo(details=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageInfo class contains information that describe a specific +ESX base image.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • details (BaseImageDetails or None) – Details about the base image. +None if base image is not present in the depot.

    • +

  • version (str) – Version of the base-image

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.BaseImageSpec(version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageSpec class contains attributes that describe a specific +ESX base-image.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

version (str) – Version of the base-image

+
+
+
+ +
+
+class com.vmware.esx.settings_client.CheckDescription(check=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckDescription class contains attributes that describe a +particular check.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.esx.settings_client.CheckError(description=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckError class contains attributes that describe an error +reported by CheckStatus

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of what was the issue containing as much user-relevant +context as possible. The user should be able to understand which +sub-system failed and why.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – Possible resolution for the issue. This should contain actionable +information that the user can use to resolve the issue. +Can be left None if no meaningful resolution exists.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.CheckStatus(check=None, status=None, originator=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckStatus class contains attributes that describe a check result.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check (CheckDescription) – Information about this check.

    • +

  • status (Status) – The status of this check.

    • +

  • originator (str or None) – The service that performed the check. This field should allow +easier triaging of health query errors. +Only set if there is an originator available for this +check.

    • +

  • errors (list of CheckError or None) – List of CheckError that the check reported. +If not set, the service is still using the {#member +issues}. TODO

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.ClusterCompliance(impact=None, status=None, stage_status=None, notifications=None, scan_time=None, commit=None, compliant_hosts=None, non_compliant_hosts=None, incompatible_hosts=None, unavailable_hosts=None, hosts=None, host_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompliance class contains attributes to describe the +compliance result of a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (ComplianceImpact) – Overall impact.

    • +

  • status (ComplianceStatus) – Overall compliance status of the cluster.

    • +

  • stage_status (StageStatus or None) – Overall stage status of the cluster. This is only relevant when the +value of ClusterCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • notifications (Notifications) – Notifications returned by the scan operation.

    • +

  • scan_time (datetime.datetime) – Scan completion time.

    • +

  • commit (str or None) – Identifier of the commit on which the scan is run to generate this +result. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +None if operation is performed on a draft.

    • +

  • compliant_hosts (set of str) – Identifiers of compliant hosts. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • non_compliant_hosts (set of str) – Identifiers of non-compliant hosts. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • incompatible_hosts (set of str) – Identifiers of incompatible hosts. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • unavailable_hosts (set of str) – Identifiers of unavailable hosts. There will not be compliance +details for these hosts in ClusterCompliance.hosts. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • hosts (dict of str and HostCompliance) – Mapping from host identifier to the compliance information for the +host. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • host_info (dict of str and HostInfo) – Auxillary information about the hosts. This gives some additional +information about the hosts referenced in this result. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.ComplianceImpact(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComplianceImpact class contains information about the impact of +applying the target state in case of non compliance.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceImpact instance.

+
+
+
+
+MAINTENANCE_MODE_REQUIRED = ComplianceImpact(string='MAINTENANCE_MODE_REQUIRED')
+

Host requires maintenance mode to reach this target state.

+
+ +
+
+NO_IMPACT = ComplianceImpact(string='NO_IMPACT')
+

Host has no impact.

+
+ +
+
+PARTIAL_MAINTENANCE_MODE_REQUIRED = ComplianceImpact(string='PARTIAL_MAINTENANCE_MODE_REQUIRED')
+

Host requires partial maintenance mode to reach this target state.

+
+ +
+
+REBOOT_REQUIRED = ComplianceImpact(string='REBOOT_REQUIRED')
+

Host requires reboot to reach this target state.

+
+ +
+
+UNKNOWN = ComplianceImpact(string='UNKNOWN')
+

Impact is unknown.

+
+ +
+ +
+
+class com.vmware.esx.settings_client.ComplianceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComplianceStatus class contains the possible different status of +compliance with respect to target version.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceStatus instance.

+
+
+
+
+COMPLIANT = ComplianceStatus(string='COMPLIANT')
+

Target version is same as current version.

+
+ +
+
+INCOMPATIBLE = ComplianceStatus(string='INCOMPATIBLE')
+

Target state cannot be applied due to conflict or missing dependencies or +the target state is lesser than the current version.

+
+ +
+
+NON_COMPLIANT = ComplianceStatus(string='NON_COMPLIANT')
+

Target version is greater than current version.

+
+ +
+
+UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')
+

Drift check failed due to unknown error or check hasn’t happened yet and +results are not available.

+
+ +
+ +
+
+class com.vmware.esx.settings_client.ComponentCompliance(status=None, stage_status=None, current=None, target=None, current_source=None, target_source=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentCompliance class contains information that describe the +compliance of a component with respect to the component present in the +target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the component.

    • +

  • stage_status (StageStatus or None) – Stage status of the component. This is only relevant when the value +of ComponentCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • current (ComponentInfo or None) – Current version of the component present on the host. +None if component is not present on the host.

    • +

  • target (ComponentInfo or None) – Target version of the component present in the software +specification. +None if component is not present in the software specification.

    • +

  • current_source (ComponentSource or None) – Source of the component on the host. +None if component is not present on the host.

    • +

  • target_source (ComponentSource or None) – Source of the component in the software specification. +None if component is not present in the software specification.

    • +

  • notifications (Notifications) – Notifications describing the compliance result.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.ComponentDetails(display_name=None, vendor=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentDetails class contains information that provide more +details about the component from the depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the component.

    • +

  • vendor (str) – Vendor of the component.

    • +

  • display_version (str or None) – Human readable version of the component. +None if no version is provided for the component.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.ComponentInfo(version=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentInfo class contains information that describe a specific +component version in a software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str or None) – Version of the component. +None if version is not specified.

    • +

  • details (ComponentDetails or None) – Details about the component. +None if component is not present in the depot.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.ComponentOverrideInfo(version=None, display_version=None, source=None, note=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentOverrideInfo class contains fields that describe how the +component was overridden.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.esx.settings_client.ComponentSource(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComponentSource class contains the component’s source information.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComponentSource instance.

+
+
+
+
+ADD_ON = ComponentSource(string='ADD_ON')
+

Addon is the source for this component

+
+ +
+
+BASE_IMAGE = ComponentSource(string='BASE_IMAGE')
+

Base image is the source for this component

+
+ +
+
+HARDWARE_SUPPORT_PACKAGE = ComponentSource(string='HARDWARE_SUPPORT_PACKAGE')
+

Hardware Support Package (HSP) is the source for this component

+
+ +
+
+SOLUTION = ComponentSource(string='SOLUTION')
+

Solution is the source for this component

+
+ +
+
+USER = ComponentSource(string='USER')
+

User is the source for this component

+
+ +
+ +
+
+class com.vmware.esx.settings_client.DataProcessingUnitCompliance(impact=None, status=None, stage_status=None, notifications=None, scan_time=None, base_image=None, add_on=None, hardware_support=None, components=None, solutions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataProcessingUnitCompliance class contains information to describe +the compliance result of a data processing unit with respect to the target +software specification. This DataProcessingUnitCompliance class is +mirror of HostCompliance, any changes in either of them should reflect in +both. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (ComplianceImpact) – Overall compliance impact of the data processing unit. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • status (ComplianceStatus) – Overall compliance status of the data processing unit. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • stage_status (StageStatus or None) – Overall stage status of the data processing unit. This is only +relevant when the value of +DataProcessingUnitCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • notifications (Notifications) – Notifications returned by the scan operation. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • scan_time (datetime.datetime) – Scan completion time. This attribute was added in vSphere API +8.0.0.1.

    • +

  • base_image (BaseImageCompliance) – Compliance result for the base image. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • add_on (AddOnCompliance) – Compliance result for the OEM add-on. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • hardware_support ((dict of str and HardwareSupportPackageCompliance) or None) – Compliance result for hardware support (both Hardware Support +Package or HSP and individual hardware module firmware) for every +HSP configured, keyed by Hardware Support Manager (HSM). This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. +This attribute will be None or contain an empty map if operation is +performed on an image whose SoftwareSpec does not have a value +for its hardwareSupport attribute. For initial release +hardwareSupport attribute would be empty.

    • +

  • components (dict of str and ComponentCompliance) – Compliance result for all user components present on the data +processing unit and in the software specification. The key is the +component name and value is the ComponentCompliance object. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • solutions (dict of str and SolutionCompliance) – Compliance result for solutions. The key is the solution name and +value is the SolutionCompliance. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.DataProcessingUnitInfo(alias=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataProcessingUnitInfo class contains attributes to describe some +details regarding a data processing unit in the inventory. This class was +added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

alias (str) – Alias of the data processing unit. This attribute is used to +identify the data processing unit on the host with a short hand +representation, that can used by vSphere’s components across the +board. Example: UI. Each data processing unit will have unique +alias on the host. Alias is persisted across the reboots and +upgrades. This attribute was added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+class com.vmware.esx.settings_client.DataProcessingUnitsCompliance(compliant_data_processing_units=None, non_compliant_data_processing_units=None, incompatible_data_processing_units=None, unavailable_data_processing_units=None, compliance=None, data_processing_unit_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataProcessingUnitsCompliance class contains information to +describe the compliance results of all data processing units with respect +to the target software specification. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compliant_data_processing_units (set of str) – Identifiers of compliant data processing units. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit.

    • +

  • non_compliant_data_processing_units (set of str) – Identifiers of non-compliant data processing units. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit.

    • +

  • incompatible_data_processing_units (set of str) – Identifiers of incompatible data processing units. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit.

    • +

  • unavailable_data_processing_units (set of str) – Identifiers of unavailable data processing units. There will not be +compliance details for these data processing units in +#dataProcessingUnits. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.esx.settings.data_processing_unit.

    • +

  • compliance (dict of str and DataProcessingUnitCompliance) – Mapping from data processing unit identifier to the compliance +information for the data processing units. This attribute was added +in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.data_processing_unit. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.data_processing_unit.

    • +

  • data_processing_unit_info (dict of str and DataProcessingUnitInfo) – Auxillary information about the data processing units. This gives +some additional information about the data processing units +referenced in this result. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.data_processing_unit. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.data_processing_unit.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.Depots(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Depots class provides methods to manage Software Depots used during +ESX lifecycle management.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+sync_task()
+

Syncs the metadata from the currently configured online or umds depots. +If any umds depot is set, then metadata is downloaded from that depot +else metadata is downloaded from the online depots. The result of this +operation can be queried by calling the cis/tasks/{task-id} where the +task-id is the response of this operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if the service is timed out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings_client.EffectiveComponentDetails(display_name=None, display_version=None, vendor=None, source=None, note=None, overridden_components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EffectiveComponentDetails class contains information that provide +more details about the component from the depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the component.

    • +

  • display_version (str) – Human readable version of the component.

    • +

  • vendor (str) – Vendor of the component.

    • +

  • source (ComponentSource) – Final effective source of the component.

    • +

  • note (com.vmware.vapi.std_client.LocalizableMessage or None) – Note assosicated with this component. +If None, note is present for this component.

    • +

  • overridden_components (list of ComponentOverrideInfo) – List of other component versions present in base image, add-ons or +solutions that this component is overriding. For example, if a +component version-1 was implicitly present in the base image, but +user wants it to be changed to version-2. In that case, +EffectiveComponentDetails.source would be USER and there +will be one entry in this list indicating base image component +version-1 is being overridden.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.EffectiveComponentInfo(version=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EffectiveComponentInfo class contains information that describe a +component and how that component appeared in the software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the component.

    • +

  • details (EffectiveComponentDetails or None) – Details about the effective component. +None if component is not present in the depot.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareModuleClass(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The HardwareModuleClass class contains the module’s source information.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HardwareModuleClass instance.

+
+
+
+
+OTHER = HardwareModuleClass(string='OTHER')
+

Other (non-PCI) hardware

+
+ +
+
+PCI_DEVICE = HardwareModuleClass(string='PCI_DEVICE')
+

PCI device

+
+ +
+
+SYSTEM_BIOS = HardwareModuleClass(string='SYSTEM_BIOS')
+

System BIOS

+
+ +
+ +
+
+class com.vmware.esx.settings_client.HardwareModuleDetails(component_class=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareModuleDetails class contains information that provide more +details about the a hardware module (e.g. BIOS, PCI device).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • component_class (HardwareModuleClass) – Class of module (BIOS, PCI Device, non-PCI hardware, etc.)

    • +

  • description (str or None) – Descipription of the hardware module (e.g. “System BIOS” or +“Frobozz 100Gb NIC”). +None if description is not specified.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance(status=None, stage_status=None, details=None, current=None, target=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareModuleFirmwareCompliance class contains information that +describe the compliance of firmware of a particular hardware module (e.g. +BIOS, PCI device) on the host with respect to the firmware present in the +target Hardware Support Package (HSP) specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the hardware module’s firmware.

    • +

  • stage_status (StageStatus or None) – Stage status of the hardware module’s firmware. This is only +relevant when the value of +HardwareModuleFirmwareCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • details (HardwareModuleDetails or None) – Additional details about the hardware module itself +None if no further info was provided by HSM.

    • +

  • current (HardwareModuleFirmwareInfo or None) – Current version of the firmware present on the host hardware +module. +None if version of firmware on the hardware module on the host +cannot be determined.

    • +

  • target (HardwareModuleFirmwareInfo or None) – Target version of the firmware present in the Hardware Support +Package (HSP). +None if component is not present in the software specification.

    • +

  • notifications (Notifications) – Notifications describing the compliance result.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareModuleFirmwareInfo(version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareModuleFirmwareInfo class contains information to describe +the firmware on a hardware component or module (e.g. BIOS, PCI device).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

version (str) – Version of the hardware module firmware.

+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareSupportInfo(packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportInfo class contains information to describe the +desired Hardware Support Package (HSP) configured for a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

packages (dict of str and HardwareSupportPackageInfo) – Map of Hardware Support Packages (HSPs) for the cluster. The key is +the Hardware Support Manager (HSM) identifier and the value is the +specification detailing the HSP configured for that HSM. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager.

+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareSupportPackageCompliance(status=None, stage_status=None, current=None, target=None, hardware_modules=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageCompliance class contains information that +describe compliance of the Hardware Support Package (HSP) on the host with +respect to the Hardware support Package (HSP) present in the target +software image specification, if any.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the Hardware Support Package (HSP).

    • +

  • stage_status (StageStatus or None) – Stage status of the Hardware Support Package (HSP). This is only +relevant when the value of +HardwareSupportPackageCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • current (HardwareSupportPackageInfo or None) – Current version of the Hardware Support Package present on the +host. +None if there is no known Hardware Support Package on the host.

    • +

  • target (HardwareSupportPackageInfo or None) – Target version of the Hardware Support Package present in the +software specification. +None if current desired image includes a Hardware Support Manager +(HSM) but no target Hardware Support Package (HSP).

    • +

  • hardware_modules (dict of str and HardwareModuleFirmwareCompliance) – Compliance result for individual hardware module on the host. The +key is the module identifier and value is the +HardwareModuleFirmwareCompliance for the device. NOTE: if no +individual hardware module compliance is returned by the, Hardware +Support Manager (HSM), this map may have no entries even if +ComplianceStatus = NON_COMPLIANT +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_module. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_module.

    • +

  • notifications (Notifications) – Notifications describing the compliance result.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareSupportPackageInfo(pkg=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageInfo class contains information to describe +the desired Hardware Support Package (HSP) configured for a single device +or distinct group of devices (typically the OEM’s, including BIOS and +device firmware).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pkg (str) – Identifier of Hardware Support Package (HSP) selected +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package.

    • +

  • version (str) – Version of the Hardware Support Package (HSP) selected (e.g. +“20180128.1” or “v42”)

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareSupportPackageSpec(pkg=None, version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageSpec class contains attributes to describe +the desired Hardware Support Package (HSP) configured for a single device +or distinct group of devices (typically the OEM’s, including BIOS, device +firmware and OEM-supplied driver or agent components).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pkg (str or None) – Hardware Support Package (HSP) selected +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package.

    • +

  • version (str or None) – Version of the Hardware Support Package (HSP) selected (e.g. +“20180128.1” or “v42”) +If None, the system will use an empty string as the version.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HardwareSupportSpec(packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportSpec class contains attributes to describe the +desired Hardware Support Package (HSP) configured for a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

packages (dict of str and HardwareSupportPackageSpec) – Map of Hardware Support Packages (HSPs) for the cluster. The key is +the Hardware Support Manager (HSM) name and the value is the +specification detailing the HSP configured for that HSM. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager.

+
+
+
+ +
+
+class com.vmware.esx.settings_client.HostCompliance(impact=None, status=None, stage_status=None, notifications=None, scan_time=None, commit=None, base_image=None, add_on=None, hardware_support=None, components=None, solutions=None, data_processing_units_compliance=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostCompliance class contains information to describe the +compliance result of a host with respect to given target software +specification. DataProcessingUnitCompliance is mirror of this class. Any +future changes in either of them should reflect in both.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (ComplianceImpact) – Overall impact.

    • +

  • status (ComplianceStatus) – Overall compliance status of the host.

    • +

  • stage_status (StageStatus or None) – Overall stage status of the host. This is only relevant when the +value of HostCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • notifications (Notifications) – Notifications returned by the scan operation.

    • +

  • scan_time (datetime.datetime) – Scan completion time.

    • +

  • commit (str or None) – Identifier of the commit on which the scan is run to generate this +result. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +None if operation is performed on a working copy document.

    • +

  • base_image (BaseImageCompliance) – Compliance result for the base image.

    • +

  • add_on (AddOnCompliance) – Compliance result for the OEM add-on.

    • +

  • hardware_support ((dict of str and HardwareSupportPackageCompliance) or None) – Compliance result for hardware support (both Hardware Support +Package or HSP and individual hardware module firmware) for every +HSP configured, keyed by Hardware Support Manager (HSM). +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. +This attribute will be None or contain an empty map if operation is +performed on an image whose SoftwareSpec does not have a value +for its hardwareSupport attribute.

    • +

  • components (dict of str and ComponentCompliance) – Compliance result for all the effective components and all the +components present on the host. The key is the component name and +value is the ComponentCompliance. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • solutions (dict of str and SolutionCompliance) – Compliance result for solutions. The key is the solution name and +value is the SolutionCompliance. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +

  • data_processing_units_compliance (DataProcessingUnitsCompliance or None) – Compliance results of all data processing units on the host. This +attribute was added in vSphere API 8.0.0.1. +This attribute will be None if host doesn’t have any data +processing units.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.HostInfo(name=None, is_vsan_witness=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostInfo class contains attributes to describe some details +regarding a host in the inventory.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the host.

    • +

  • is_vsan_witness (bool or None) – Indicates if the host is associated with a cluster as a vSAN +witness. This attribute was added in vSphere API 7.0.2.1. +This attribute is set only when the host is associated +with a vSAN cluster as a witness.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.Notification(type=None, id=None, time=None, message=None, resolution=None, originator=None, retriable=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class contains attributes to describe any +info/warning/error messages that Tasks can raise.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Notification.Type) – Type of the notification. This attribute was added in vSphere API +7.0.2.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • id (str) – The notification id.

    • +

  • time (datetime.datetime) – The time the notification was raised/found.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. +Only set if there is a resolution available for this +notification.

    • +

  • originator (str or None) – The originator of the notification. This attribute was added in +vSphere API 7.0.2.0. +Only set if there is an originator available for this +notification.

    • +

  • retriable (bool or None) – Indicates whether the error is retriable. This attribute was added +in vSphere API 7.0.2.0. +Only set for the notification when a retriable error was +reported by the task.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The (\@name Type} class contains the possible different types of +notification. This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+ERROR = Type(string='ERROR')
+
+ +
+
+INFO = Type(string='INFO')
+
+ +
+
+WARNING = Type(string='WARNING')
+
+ +
+ +
+ +
+
+class com.vmware.esx.settings_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported by the task.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. +Only set if an info was reported by the task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. +Only set if an warning was reported by the task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. +Only set if an error was reported by the task.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SoftwareInfo(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SoftwareInfo class contains information that describes the desired +software specification for an ESX host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • base_image (BaseImageInfo) – Base image of the ESX.

    • +

  • add_on (AddOnInfo or None) – OEM customization on top of given base image. The components in +this customization override the components in the base base image. +If None, no OEM customization will be applied.

    • +

  • components (dict of str and ComponentInfo) – Information about the components in the software specification. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • solutions (dict of str and SolutionInfo) – Information about the solutions in the software specification. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +

  • hardware_support (HardwareSupportInfo or None) – Information about the Hardware Support Packages (HSP) configured. +If None, no Hardware Support Package (HSP) is specified for the +cluster.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SoftwareSpec(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SoftwareSpec class contains attributes that describe desired +software specification for an ESX host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • base_image (BaseImageSpec) – Base image of the ESX.

    • +

  • add_on (AddOnSpec or None) – OEM customization on top of given base-image. The components in +this customization override the components in the base base-image. +If None, no OEM customization will be applied.

    • +

  • components ((dict of str and (str or None)) or None) – Additional components which should be part of the software +specification. If value is not given for a particular component +then version for that component will be picked from the +constraints. These override the components present in +SoftwareSpec.add_on and SoftwareSpec.base_image. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component. +If None, no additional components will be installed.

    • +

  • solutions ((dict of str and SolutionSpec) or None) – Mapping from solution identifier to the solution specification. The +key is the solution name and the value is the specification +detailing components registered by that solution. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.solution. +If None, no solutions will be part of the software specification.

    • +

  • hardware_support (HardwareSupportSpec or None) – Information about the Hardware Support Package (HSP) configured in +the software specification. +If None or empty, no firmware compliance checking or remediation +will be done.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SolutionCompliance(status=None, stage_status=None, current=None, target=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionCompliance class contains information that describe the +compliance result of a host with respect to given solution present in the +target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the solution.

    • +

  • stage_status (StageStatus or None) – Stage status of the solution. This is only relevant when the value +of SolutionCompliance.status is +ComplianceStatus.NON_COMPLIANT. This attribute was added in +vSphere API 8.0.0.1. +If None the staging status is unknown - the contents may or may not +be staged. This can happen, for instance, if the stage check +failed, has not been done yet, or the target uses an older +interface that does not include support for returning the staged +status.

    • +

  • current (SolutionInfo or None) – Current solution present on the host. +None if the solution is not present on the host.

    • +

  • target (SolutionInfo or None) – Target solution present in the software specification. +None if solution is not present in the software specification.

    • +

  • notifications (Notifications) – Notifications describing the compliance result.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SolutionComponentDetails(component=None, display_name=None, display_version=None, vendor=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionComponentDetails class contains information that provide +more details about component registered by the solution from depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • component (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +

  • display_version (str or None) – Human readable version of the component. +None if no version is provided for the component.

    • +

  • vendor (str) – Vendor of the component.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SolutionComponentSpec(component=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionComponentSpec class contains attributes that describe a +component registered by a software solution.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

component (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

+
+
+
+ +
+
+class com.vmware.esx.settings_client.SolutionDetails(display_name=None, display_version=None, components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionDetails class contains information that provide more +details about the solution from the depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the solution.

    • +

  • display_version (str) – Display version of the solution.

    • +

  • components (list of SolutionComponentDetails) – Components registered by the solution. If the component is not +present in the depot, then corresponding details are absent from +the list.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SolutionInfo(details=None, version=None, components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionInfo class contains information that describe solution +registered in the software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • details (SolutionDetails or None) – Details about the solution from the depot. +None if solution is not present in the depot.

    • +

  • version (str) – Version of the solution.

    • +

  • components (list of SolutionComponentSpec) – Components registered by the solution.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.SolutionSpec(version=None, components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionSpec class contains attributes that describe solution +registered in the software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the solution.

    • +

  • components (list of SolutionComponentSpec) – Components registered by the solution.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.StageStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The StageStatus class contains the possible different staged statuses +with respect to target version. This is only relevant when the value of +ComplianceStatus is ComplianceStatus.NON_COMPLIANT. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StageStatus instance.

+
+
+
+
+NOT_STAGED = StageStatus(string='NOT_STAGED')
+

Required components/payloads are not staged. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+STAGED = StageStatus(string='STAGED')
+

Required components/payloads are already staged. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class com.vmware.esx.settings_client.Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Status class defines the status result for a particular check.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The check indicates an error.

+
+ +
+
+OK = Status(string='OK')
+

The check indicates a success.

+
+ +
+
+RETRY = Status(string='RETRY')
+

The check failed because of an intermittent error, for example a service is +overloaded. The client can choose to retry the health check before +considering the check as failed.

+
+ +
+
+TIMEOUT = Status(string='TIMEOUT')
+

The check did not return in a timely manner.

+
+ +
+
+WARNING = Status(string='WARNING')
+

The check indicates a warning.

+
+ +
+ +
+
+class com.vmware.esx.settings_client.StatusInfo(status=None, check_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StatusInfo class contains attributes that describe aggregated +status of all checks performed on an entity.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Status) – Aggregated status from all checks performed on this entity.

    • +

  • check_statuses (list of CheckStatus) – List of CheckStatus for all checks performed.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings_client.TaskInfo(progress=None, subtasks=None, notifications=None, result=None, last_update_time=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TaskInfo class contains information about a task and its subtasks +of which it consists.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – Progress of the operation. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • subtasks ((dict of str and TaskInfo) or None) – Information about the subtasks that this task contains. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.cis.task. When methods return a value of this +class as a return value, the key in the attribute dict +will be an identifier for the resource type: +com.vmware.cis.task. +This attribute will be None if the task has no subtasks.

    • +

  • notifications (Notifications or None) – Notifications to the user +Only set if the notifications were reported by this +particular task.

    • +

  • result (DataValue or None) – Task result. +This attribute will be None if the task has no result.

    • +

  • last_update_time (datetime.datetime) – Time when the task was last updated. This attribute was added in +vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.configuration.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.configuration.html new file mode 100644 index 00000000..9b1a7060 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.configuration.html @@ -0,0 +1,494 @@ + + + + + + + com.vmware.esx.settings.clusters.configuration package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.configuration package

+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.configuration.reports_client module

+
+
+class com.vmware.esx.settings.clusters.configuration.reports_client.LastApplyResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastApplyResult class provides methods to get the most recent +available result of applying the configuration to all hosts within a +cluster. This class was added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

Returns the most recent available result of applying the configuration +document to all hosts within the cluster. This method was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters_client.Configuration.ApplyResult

+
+
Returns
+

Most recent available result of applying the desired configuration +to all hosts within the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if there is no result associated with the cluster cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller does not have the necessary privileges to perform the +request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration.reports_client.LastComplianceResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastComplianceResult class provides methods to get the last +available check compliance result for the cluster. This class was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

This API provides results from the last completed Check Compliance +operation on the cluster. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no last +compliance result was found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration.reports_client.LastPrecheckResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastPrecheckResult class provides methods to get the most recent +available result of Precheck. This class was added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

This API returns results from the last Precheck operation on the +cluster. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult

+
+
Returns
+

Most recent available result of Precheck.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if there is no result associated with the cluster cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller does not have the necessary privileges to perform the +request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration.reports_client.RecentTasks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The RecentTasks class provides methods to get the most recent +configuration-related tasks. This class was added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DraftTasks(precheck=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The RecentTasks.DraftTasks class contains attributes that specify the +ID of the latest task to be executed for various operations on a draft. +This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

precheck (str or None) – The ID of the last precheck task to be executed for this draft. +This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task.

+
+
+
+ +
+
+class Info(check_compliance=None, precheck=None, draft_tasks=None, apply=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The RecentTasks.Info class contains attributes that specify the ID of +the latest task to be executed for various operations. If a task is +currently running, that ID will be returned, otherwise the most recently +finished task will be returned. This class was added in vSphere API +8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check_compliance (str or None) – The ID of the last check-compliance task to be executed. This +attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task.

    • +

  • precheck (str or None) – The ID of the last precheck task to be executed. This attribute was +added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task.

    • +

  • draft_tasks (dict of str and RecentTasks.DraftTasks) – Map of draft IDs to the latest tasks executed for that draft. This +attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.draft. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • apply (str or None) – The ID of the last apply task to be executed. This attribute was +added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task.

    • +
+
+
+
+ +
+
+get(cluster)
+

This API returns the IDs of the configuration tasks most recently +executed on this cluster. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

RecentTasks.Info

+
+
Returns
+

A structure containing the most recent executions of draft- related +tasks.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller does not have the necessary privileges to perform the +request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration.reports_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.enablement.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.enablement.html new file mode 100644 index 00000000..3ed2493e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.enablement.html @@ -0,0 +1,1127 @@ + + + + + + + com.vmware.esx.settings.clusters.enablement package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.enablement package

+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.enablement.configuration_client module

+

The com.vmware.esx.settings.clusters.enablement.configuration_client module +provides classes to manage enablement of configuration on an ESX cluster.

+
+
+class com.vmware.esx.settings.clusters.enablement.configuration_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.enablement.configuration_client.Transition(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Transition class provides methods to manage transition of an +existing cluster to a desired configuration managed cluster. This class was +added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EligibilityResult(status=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This Transition.EligibilityResult class contains attributes that +describe the result of the eligibility checks performed on the cluster to +determine if the cluster can transition to desired configuration management +platform. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Transition.EligibilityResult.Status) – Status of eligibility checks performed on a cluster. This attribute +was added in vSphere API 8.0.1.0.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information about the status of +eligibility checks. This attribute was added in vSphere API +8.0.1.0. +This field is None when Transition.EligibilityResult.status +is ELLIGIBLE.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Transition.EligibilityResult.Status class contains the possible +status codes describing the result of eligibility checks. This enumeration +was added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ELIGIBLE = Status(string='ELIGIBLE')
+

This indicates that the cluster meets all the eligibility requirements. +This class attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+NOT_ELIGIBLE = Status(string='NOT_ELIGIBLE')
+

This indicates that the cluster does not meet the eligibility requirements. +This class attribute was added in vSphere API 8.0.1.0.

+
+ +
+ +
+ +
+
+class EnableResult(status=None, errors=None, apply_task_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transition.EnableResult class contains attributes that describes +the result of enabling configmanager on a cluster as part of the transition +process. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Transition.EnableResult.Status) – Status of enabling configmanager on a cluster. This attribute was +added in vSphere API 8.0.1.0.

    • +

  • errors (list of com.vmware.esx.settings_client.Notification) – List of errors if any. This attribute was added in vSphere API +8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is Transition.EnableResult.Status.ERROR.

    • +

  • apply_task_id (str) – ID of the Apply task invoked once ConfigManager is enabled on the +cluster. This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute is optional and it is only relevant when the value +of status is +Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Transition.EnableResult.Status class contains the status of Enable +API. This enumeration was added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

Failed to enable ConfigManager on the cluster. This class attribute was +added in vSphere API 8.0.1.0.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The task is in-progress. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+
+SUCCESS = Status(string='SUCCESS')
+

ConfigMnager enabled on the cluster. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+
+SUCCESS_APPLY_INITIATED = Status(string='SUCCESS_APPLY_INITIATED')
+

ConfigMnager enabled on the cluster and remediation was initiated. This +class attribute was added in vSphere API 8.0.1.0.

+
+ +
+ +
+ +
+
+class FileSpec(filename=None, config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transition.FileSpec contain attributes that contains the details of +the file being imported during transition process. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • filename (str) – Filename of the imported configuration. This attribute was added in +vSphere API 8.0.1.0.

    • +

  • config (str) – Configuration from the imported file. This attribute was added in +vSphere API 8.0.1.0.

    • +
+
+
+
+ +
+
+class Info(status=None, state=None, fast_track=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transition.Info class contains attributes that describe the current +status of transition process in the cluster. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Transition.Info.Status) – Status of transition on a cluster. This attribute was added in +vSphere API 8.0.1.0.

    • +

  • state (Transition.State) – State of the transition. This field is set if the cluster +is currently being transitioned to desired configuration management +platform. This attribute was added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is one of Transition.Info.Status.STARTED or +Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE.

    • +

  • fast_track (bool) – Flag describing if fast transition workflow is eligible on the +cluster. Fast transition allows user to enable desired +configuration platform on the cluster with default configuration. +The cluster is eligible if transition workflow is not started and +the cluster is empty. This attribute was added in vSphere API +8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is Transition.Info.Status.NOT_STARTED.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Transition.Info.Status class contains the possible status codes +describing the transition state of the cluster. This enumeration was added +in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ENABLED = Status(string='ENABLED')
+

Transition has completed successfully and the cluster is managed through +the desired configuration management platform. This class attribute was +added in vSphere API 8.0.1.0.

+
+ +
+
+ENABLE_IN_PROGRESS = Status(string='ENABLE_IN_PROGRESS')
+

Transition has started and Transition.enable() task is running on the +cluster. This class attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+NOT_ALLOWED_IN_CURRENT_STATE = Status(string='NOT_ALLOWED_IN_CURRENT_STATE')
+

Cluster is not in a state to transition to desired configuration management +platform. The cluster ends up in this state if another user identified by +Transition.State.author has already started transition. This class +attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+NOT_STARTED = Status(string='NOT_STARTED')
+

Transition has not started on the cluster. This class attribute was added +in vSphere API 8.0.1.0.

+
+ +
+
+SOFTWARE_SPECIFICATION_NOT_SET = Status(string='SOFTWARE_SPECIFICATION_NOT_SET')
+

Desired software specification is not set on the cluster. This is a +pre-requisite to transition a cluster to desired configuration management +platform. This class attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+STARTED = Status(string='STARTED')
+

Transition has started on the cluster. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+ +
+ +
+
+class ReferenceHost(host=None, host_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transition.ReferenceHost contains attributes that specify the +reference host information used by the transition process. This class was +added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – Reference host ID. This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Host Info for Reference host. This attribute was added in vSphere +API 8.0.1.0.

    • +
+
+
+
+ +
+
+class Source(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Transition.Source class describes the possible sources for +specifying the desired configuration of the cluster. This enumeration was +added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Source instance.

+
+
+
+
+FILE = Source(string='FILE')
+

This indicates that desired configuration originated from a file. This +class attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+HOST = Source(string='HOST')
+

This indicates that desired configuration originated from a reference host. +This class attribute was added in vSphere API 8.0.1.0.

+
+ +
+ +
+
+class State(author=None, start_time=None, modified_time=None, source=None, host=None, filename=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transition.State class contains attributes that describe the latest +state of transitioning a cluster to desired configuration management +platform. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • author (str) – Author of transition. This attribute was added in vSphere API +8.0.1.0.

    • +

  • start_time (datetime.datetime) – The start time of the transition process. This attribute was added +in vSphere API 8.0.1.0.

    • +

  • modified_time (datetime.datetime) – Last modified time of the transition process. This attribute was +added in vSphere API 8.0.1.0.

    • +

  • source (Transition.Source) – Source of reference configuration. This attribute was added in +vSphere API 8.0.1.0.

    • +

  • host (Transition.ReferenceHost) – Reference host. This attribute was added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of source is Transition.Source.HOST.

    • +

  • filename (str) – Filename of the imported configuration. This attribute was added in +vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of source is Transition.Source.FILE.

    • +
+
+
+
+ +
+
+class ValidateResult(status=None, errors=None, compliance=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transition.ValidateResult class contains attributes that describe +the validity of the imported desired configuration, and compliance +information. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Transition.ValidateResult.Status class contains the possible status +codes describing the result of validating configuration draft. This +enumeration was added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+INVALID = Status(string='INVALID')
+

This indicates that the configuration draft is invalid. This class +attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+VALID = Status(string='VALID')
+

This indicates that the configuration draft is valid. This class attribute +was added in vSphere API 8.0.1.0.

+
+ +
+ +
+ +
+
+cancel(cluster)
+

This API cancels the workflow to transition the cluster to desired +configuration platform. If the status of transition is +Transition.Info.Status.STARTED, the associated state +information will be deleted. Otherwise, cancel will not be allowed and +the API will throw an error. This method was added in vSphere API +8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the status of transition process is not +Transition.Info.Status.STARTED.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+
+check_eligibility_task(cluster)
+

The API performs eligibility checks on the cluster to see if it can be +transitioned to desired configuration management platform. This method +was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+enable_task(cluster)
+

The API enables ConfigManager on the cluster. Before setting the +desired configuration state, the API verifies the eligibility of the +cluster to transition to desired configuration platform. The API then +validates and sets the configuration draft as the desired configuration +of the cluster, thus enabling ConfigManager. The API finally initiates +remediation by invoking Apply. Apply is not invoked if the cluster is +empty. The API does not wait for remediation to complete before +returning. If any of the above step fails, the API will fail and result +will contain descriptive error messages. This method was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+export_config(cluster)
+

This API will export configuration associated with the cluster +generated as part of the transition workflow. The API will throw an +error if the transition state is not +Transition.Info.Status.STARTED. This method was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster on which operation should be performed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters.configuration_client.ExportResult

+
+
Returns
+

This output structure of type +com.vmware.esx.settings.clusters.configuration_client.ExportResult +contains the configuration document encoded as JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the status of transition process is not +Transition.Info.Status.STARTED.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Export.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Export.

    • +
+
+
+
+ +
+
+export_schema(cluster)
+

This API will export schema associated with the cluster. The API will +throw an error if the transition state is not +Transition.Info.Status.STARTED. This method was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster on which operation should be performed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters.configuration_client.SchemaResult

+
+
Returns
+

This output structure of type +com.vmware.esx.settings.clusters.configuration_client.SchemaResult +containing the schema document encoded as JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the status of transition process is not +Transition.Info.Status.STARTED.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Export.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Export.

    • +
+
+
+
+ +
+
+get(cluster)
+

This API returns the current transition state of the cluster. This +method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Transition.Info

+
+
Returns
+

The transition state of the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+
+import_from_file(cluster, spec)
+

The API imports the desired configuration from a file. Import API does +not validate the configuration against the schema. The result will +specify if the configuration was imported successfully. The result will +provide localized error message if the import operation failed. This +method was added in vSphere API 8.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Transition.FileSpec) – Input structure containing file information.

    • +
+
+
Return type
+

com.vmware.esx.settings.clusters.configuration_client.DraftImportResult

+
+
Returns
+

Output structure containing the status of the operation and error +if any.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+
+import_from_host_task(cluster, host)
+

The API imports the desired configuration from a reference host in the +cluster. The API also adds host-specific and host-overrides from the +other hosts in the cluster. Import API does not validate the +configuration against the schema. The result will specify if the +configuration was imported successfully. The result will provide +localized error message if the import operation failed. This method was +added in vSphere API 8.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • host (str) – Identifier of the reference host +The parameter must be an identifier for the resource type: +HostSystem.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+precheck_task(cluster)
+

The API computes impact of transitioning the cluster to be managed by +desired configuration platform. It also runs health checks to verify +the cluster’s health before transitioning. The API returns the impact +on the hosts in the cluster and the result of health checks from the +cluster and hosts. Health checks are run only if the host needs be +rebooted or put in maintenanceMode. This method was added in vSphere +API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+validate_config_task(cluster)
+

The API validates the imported desired configuration against the schema +and on the hosts with validation plugins. If the document is valid, the +API will check all the hosts for compliance with the desired +configuration. The API returns validation errors if the configuration +is not valid on any of the host. If the configuration is valid, the API +returns compliance information. This method was added in vSphere API +8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.html new file mode 100644 index 00000000..14853c15 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.html @@ -0,0 +1,5610 @@ + + + + + + + com.vmware.esx.settings.clusters package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings.clusters package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.configuration_client module

+

The com.vmware.esx.settings.clusters.configuration_client module provides +classes to manage the configuration of an ESX cluster. The +com.vmware.esx.settings.clusters.configuration.reports_client module +provides classes for accessing reports regarding the configuration state of the +cluster.

+
+
+class com.vmware.esx.settings.clusters.configuration_client.AuditRecords(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AuditRecords class provides methods to get the auditing records of +the configuration actions performed on a cluster in vCenter Server. This +class was added in vSphere API 8.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(operations=None, usernames=None, time_duration=None, time_period=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuditRecords.FilterSpec class contains attributes used to filter +the audit records. If multiple attributes are specified, only records +matching all of the attributes match the filter. This class was added in +vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • operations (set of str or None) –

    List of audit records that match the given operations An operation +in operations can be any of

    +
      +

    • Import

      • +

    • Export

      • +

    • Remediate

      • +

    • Checkcompliance

      • +

    • Precheck

      • +

    • Transition-Enable

      • +

    • Draft-List

      • +

    • Draft-Create

      • +

    • Draft-ImportFromHost

      • +

    • Draft-Get

      • +

    • Draft-ExportConfig

      • +

    • Draft-Update

      • +

    • Draft-ShowChanges

      • +

    • Draft-CheckCompliance

      • +

    • Draft-Precheck

      • +

    • Draft-Delete

      • +

    • Draft-Apply

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +If None or empty, records with any operation match the filter.

    +

    • +

  • usernames (set of str or None) – List of audit records that match the given users. This attribute +was added in vSphere API 8.0.2.0. +If None or empty, records with any users match the filter.

    • +

  • time_duration (AuditRecords.FilterSpec.Timeframe or None) – List of audit records that match +AuditRecords.FilterSpec.Timeframe, valid values are +THREE_MONTHS, SIX_MONTHS, YEAR, CUSTOM. i.e. For ex: records within +last 3 months. This attribute was added in vSphere API 8.0.2.0. +If None or empty, last one year audit records match the filter.

    • +

  • time_period (AuditRecords.TimePeriod) – List of audit records that match the given start time i.e. occurred +after the AuditRecords.TimePeriod.start and the given end +time i.e. before the AuditRecords.TimePeriod.end. This +attribute was added in vSphere API 8.0.2.0. +This attribute is optional and it is only relevant when the value +of timeDuration is +AuditRecords.FilterSpec.Timeframe.CUSTOM.

    • +
+
+
+
+
+class Timeframe(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

List of audit records that match the given time frame i.e. For ex: occurred +within last 30 days. This enumeration was added in vSphere API 8.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Timeframe instance.

+
+
+
+
+CUSTOM = Timeframe(string='CUSTOM')
+

To indicate custom time frame for getting audit records. Users can specify +start time and end time. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+
+SIX_MONTHS = Timeframe(string='SIX_MONTHS')
+

To indicate last 6 months audit records. This class attribute was added in +vSphere API 8.0.2.0.

+
+ +
+
+THREE_MONTHS = Timeframe(string='THREE_MONTHS')
+

To indicate last 3 months audit records. This class attribute was added in +vSphere API 8.0.2.0.

+
+ +
+
+YEAR = Timeframe(string='YEAR')
+

To indicate last 1 year audit records. This class attribute was added in +vSphere API 8.0.2.0.

+
+ +
+ +
+ +
+
+class Info(cluster_id=None, operation=None, username=None, start_time=None, end_time=None, status=None, operation_details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuditRecords.Info class contains Audit Info of an operation for a +cluster in vCenter Server. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster_id (str) – Identifier of the cluster. This attribute was added in vSphere API +8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • operation (str) –

    Name of the operation which can be one of

    +
      +

    • Import

      • +

    • Export

      • +

    • Remediate

      • +

    • Checkcompliance

      • +

    • Precheck

      • +

    • Transition-Enable

      • +

    • Draft-List

      • +

    • Draft-Create

      • +

    • Draft-ImportFromHost

      • +

    • Draft-Get

      • +

    • Draft-ExportConfig

      • +

    • Draft-Update

      • +

    • Draft-ShowChanges

      • +

    • Draft-CheckCompliance

      • +

    • Draft-Precheck

      • +

    • Draft-Delete

      • +

    • Draft-Apply

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be one of Import, Export, Remediate, +Checkcompliance, Precheck, Transition-Enable, +Draft-List, Draft-Create, Draft-ImportFromHost, +Draft-Get, Draft-ExportConfig, Draft-Update, +Draft-ShowChanges, Draft-CheckCompliance, +Draft-Precheck, Draft-Delete, or Draft-Apply. When +methods return a value of this class as a return value, the +attribute will be one of Import, Export, Remediate, +Checkcompliance, Precheck, Transition-Enable, +Draft-List, Draft-Create, Draft-ImportFromHost, +Draft-Get, Draft-ExportConfig, Draft-Update, +Draft-ShowChanges, Draft-CheckCompliance, +Draft-Precheck, Draft-Delete, or Draft-Apply.

    +

    • +

  • username (str) – User who initiated the operation. This attribute was added in +vSphere API 8.0.2.0.

    • +

  • start_time (datetime.datetime or None) – Time when the operation AuditRecords.Info.operation was +started. This attribute was added in vSphere API 8.0.2.0. +startTime might not be available for a task.

    • +

  • end_time (datetime.datetime or None) – Time when the operation AuditRecords.Info.operation was +completed. This attribute was added in vSphere API 8.0.2.0. +endTime might not be available for a task.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation AuditRecords.Info.operation. This +attribute was added in vSphere API 8.0.2.0.

    • +

  • operation_details (AuditRecords.OperationDetails or None) – Details of the operation. This attribute was added in vSphere API +8.0.2.0. +operationdetails might not be available for an operation which is +not a task.

    • +
+
+
+
+ +
+
+class OperationDetails(error=None, task_id=None, draft_id=None, cancelled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuditRecords.OperationDetails class contains Operation Details of +an operation. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • error (Exception or None) – Error occurred during the operation. This attribute was added in +vSphere API 8.0.2.0. +error shall only be set if configmanager operation is a task

    • +

  • task_id (str or None) – TaskId of the operation. This attribute was added in vSphere API +8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +taskId shall only be set if configmanager operation is a task

    • +

  • draft_id (str or None) – Draft ID of the draft operation. This attribute was added in +vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.draft. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.draft. +draftId shall only be set if this is an operaton on draft

    • +

  • cancelled (bool or None) – Indicates if the operation was cancelled. This attribute was added +in vSphere API 8.0.2.0. +cancelled shall only be set if configmanager operation is a task

    • +
+
+
+
+ +
+
+class OperationType
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuditRecords.OperationType class contains class attributes used to +represent all possible config manager operations. This class was added in +vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
+CHECK_COMPLIANCE = 'Checkcompliance'
+

Represents Check compliance config manager operation {\@link +com.vmware.esx.settings.clusters. Configuration#checkCompliance}. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_APPLY = 'Draft-Apply'
+

Represents Configmanager Draft Apply +com.vmware.esx.settings.clusters.configuration.Drafts#impact. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_CHECK_COMPLIANCE = 'Draft-CheckCompliance'
+

Represents Configmanager Draft Check Compliance {\@link +com.vmware.esx.settings.clusters.configuration .Drafts#CheckCompliance}. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_CREATE = 'Draft-Create'
+

Represents Configmanager Draft Create Drafts.create(). This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_DELETE = 'Draft-Delete'
+

Represents Configmanager Draft Delete Drafts.delete(). This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_EXPORT_CONFIG = 'Draft-ExportConfig'
+

Represents Configmanager Draft Export Config {\@link +com.vmware.esx.settings.clusters.configuration .Drafts#exportConfig}. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_GET = 'Draft-Get'
+

Represents Configmanager Draft Get Drafts.get(). This class attribute was +added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_IMPORT_FROM_HOST = 'Draft-ImportFromHost'
+

Represents Configmanager Draft Import from host {\@link +com.vmware.esx.settings.clusters.configuration .Drafts#importFromHost}. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_LIST = 'Draft-List'
+

Represents Configmanager Draft List Drafts.list(). This class attribute +was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_PRECHECK = 'Draft-Precheck'
+

Represents Configmanager Draft Precheck {\@link +com.vmware.esx.settings.clusters.configuration .Drafts#precheck}. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_SHOW_CHANGES = 'Draft-ShowChanges'
+

Represents Configmanager Draft Show Changes {\@link +com.vmware.esx.settings.clusters.configuration .Drafts#showChanges}. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DRAFT_UPDATE = 'Draft-Update'
+

Represents Configmanager Draft Update Drafts.update(). This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+EXPORT = 'Export'
+

Represents Export config manager operation +com.vmware.esx.settings.clusters_client.Configuration.export_config(). +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+IMPORT = 'Import'
+

Represents Import config manager operation +com.vmware.esx.settings.clusters_client.Configuration.import_config(). +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+OPERATIONS = ['Import', 'Export', 'Remediate', 'Checkcompliance', 'Precheck', 'Transition-Enable', 'Draft-List', 'Draft-Create', 'Draft-ImportFromHost', 'Draft-Get', 'Draft-ExportConfig', 'Draft-Update', 'Draft-ShowChanges', 'Draft-CheckCompliance', 'Draft-Precheck', 'Draft-Delete', 'Draft-Apply']
+

Represents all audit enabled config manager operations. This class attribute +was added in vSphere API 8.0.2.0.

+
+ +
+
+PRE_CHECK = 'Precheck'
+

Represents Pre-check config manager operation +com.vmware.esx.settings.clusters_client.Configuration.precheck(). This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+REMEDIATE = 'Remediate'
+

Represents Remediate config manager operation +com.vmware.esx.settings.clusters_client.Configuration.apply(). This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+TRANSITION_ENABLE = 'Transition-Enable'
+

Represents Transition enable config manager operation {\@link +com.vmware.esx.settings.clusters.enablement. configuration.Transition#enable}. +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+ +
+
+class TimePeriod(start=None, end=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuditRecords.TimePeriod class contains +AuditRecords.TimePeriod.start and +AuditRecords.TimePeriod.end to get audit records for a specific +time period. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • start (datetime.datetime) – List of audit records that match the given start time i.e. occurred +after the DateTime start. This attribute was added in vSphere API +8.0.2.0.

    • +

  • end (datetime.datetime) – List of audit records that match the given end time i.e. occurred +before the DateTime end. This attribute was added in vSphere API +8.0.2.0.

    • +
+
+
+
+ +
+
+list(cluster, filters=None)
+

Retrieves audit information about the configuration actions performed +on the cluster. This method was added in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • filters (AuditRecords.FilterSpec or None) – used to filter the audit records. +If {\@term.unset} returns all available audit records associated +with cluster

    • +
+
+
Return type
+

list of AuditRecords.Info

+
+
Returns
+

audit Information about the cluster associated with cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the session id is missing from the request or the corresponding +session object cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t not have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance(cluster_status=None, commit=None, software_commit=None, summary=None, host_info=None, hosts=None, compliant_hosts=None, non_compliant_hosts=None, failed_hosts=None, skipped_hosts=None, end_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This ClusterCompliance class contains attributes that describe the +compliance result for each host in the cluster as well as overall cluster +compliance status. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster_status (ClusterCompliance.Status) – Consolidated status of all host compliance checks. This attribute +was added in vSphere API 8.0.1.0.

    • +

  • commit (str or None) – This identifier refers to the commit action of importing the +desired configuration document. It will not be set for a draft +execution of check compliance. This attribute was added in vSphere +API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • software_commit (str) – The current commit ID for the software associated with the cluster. +This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • summary (com.vmware.vapi.std_client.LocalizableMessage) – Summarizing check compliance operation on the hosts in the cluster. +This attribute was added in vSphere API 8.0.1.0.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Map of host IDs to hostname. This attribute was added in vSphere +API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • hosts (dict of str and HostResult) – Map of host IDs to their compliance results. This attribute was +added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • compliant_hosts (set of str) – Identifiers of compliant hosts. This attribute was added in vSphere +API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • non_compliant_hosts (set of str) – Identifiers of non-compliant hosts. This attribute was added in +vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • failed_hosts (set of str) – Identifiers of hosts where the operation failed. This attribute was +added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • skipped_hosts (set of str) – Identifiers of hosts where the operation was skipped. i.e +disconnected hosts. This attribute was added in vSphere API +8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • end_time (datetime.datetime) – CheckCompliance completion time. This attribute was added in +vSphere API 8.0.1.0.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Consolidated compliance status of the cluster. This enumeration was added +in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+COMPLIANT = Status(string='COMPLIANT')
+

All hosts in the cluster are compliant. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+
+NOT_COMPLIANT = Status(string='NOT_COMPLIANT')
+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The task is in-progress. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult(status=None, commit=None, software_commit=None, end_time=None, summary=None, remediation_summary=None, remediation_notes=None, host_info=None, host_precheck=None, precheck_result=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrecheckResult class contains attributes that describe precheck +status of applying the desired document to a group of hosts. This class was +added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ClusterPrecheckResult.Status) – Overall status of precheck on the cluster. Operation is sucessfull +when precheck is run on all hosts successfully and no validation or +precheck errors are detected. This attribute was added in vSphere +API 8.0.1.0.

    • +

  • commit (str or None) – This identifier refers to the commit action of importing the +desired configuration document. This attribute was added in vSphere +API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +This field is s not set for a precheck of a draft configuration.

    • +

  • software_commit (str) – The current commit ID for the software associated with the cluster. +This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • end_time (datetime.datetime) – Precheck completion time. This attribute was added in vSphere API +8.0.1.0.

    • +

  • summary (com.vmware.vapi.std_client.LocalizableMessage) – Summarizing precheck operation on the host and cluster. This +attribute was added in vSphere API 8.0.1.0.

    • +

  • remediation_summary (list of com.vmware.vapi.std_client.LocalizableMessage) – Summarizing remediation stating number of hosts needing reboot and +maintenance mode during remediation and number of precheck errors +on host and cluster. This attribute was added in vSphere API +8.0.1.0.

    • +

  • remediation_notes (list of com.vmware.vapi.std_client.LocalizableMessage) – Static notes to the user describing steps that will be taken during +remediation. This attribute was added in vSphere API 8.0.1.0.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Map of host IDs to hostname. This attribute was added in vSphere +API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • host_precheck (dict of str and HostPrecheckResult) – Map of host IDs to their precheck results. If +ClusterPrecheckResult.status is ERROR, This field will +contain Validation errors or Host Impact and Health Check errors. +If ClusterPrecheckResult.status is OK, This field will +contain Impact and Health Check information. This attribute was +added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • precheck_result (com.vmware.esx.settings_client.StatusInfo or None) – This field represents the precheck results on the cluster, if any +one host in the cluster needs to be put in maintenance mode or to +be rebooted. This attribute was added in vSphere API 8.0.1.0. +This field is set if cluster prechecks are invoked.

    • +

  • successful_hosts (set of str) – Hosts in this cluster where the precheck was sucessfully run. This +attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • failed_hosts (set of str) – Hosts in this cluster where the precheck failed to run. This +attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • skipped_hosts (set of str) – Hosts in this cluster where the precheck was not tried because the +host was disconnected. This attribute was added in vSphere API +8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ClusterPrecheckResult.Status class contains the possible statuses +of the Precheck API on the cluster. This enumeration was added in vSphere +API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The operation failed with errors. This class attribute was added in vSphere +API 8.0.1.0.

+
+ +
+
+OK = Status(string='OK')
+

The operation completed successfully. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The task is in-progress. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ComplianceInfo(sets=None, adds=None, deletes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComplianceInfo class contains attributes that describe the +configuration drift between the desired document and the configurations on +the ESXi host. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • sets (list of SettingCompliance or None) – List of configuration drifts represented by +SettingCompliance. Each describing a configuration whose +value on ESXi host is different to that in the desired document. +This attribute was added in vSphere API 8.0.1.0. +This field is None if there are no drifts to report in this +category.

    • +

  • adds (list of SettingCompliance or None) – List of configuration drifts represented by +SettingCompliance. Each describing a configuration that is +present in the desired document but absent on the ESXi host. This +attribute was added in vSphere API 8.0.1.0. +This field is None if there are no drifts to report in this +category.

    • +

  • deletes (list of SettingCompliance or None) – List of configuration drifts represented by +SettingCompliance. Each describing a configuration that is +present on the ESXi host but absent in the desired document. This +attribute was added in vSphere API 8.0.1.0. +This field is None if there are no drifts to report in this +category.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

This ComplianceStatus class represents the compliance status of desired +configuration on the ESXi host. This enumeration was added in vSphere API +8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceStatus instance.

+
+
+
+
+COMPLIANT = ComplianceStatus(string='COMPLIANT')
+

ESXi host is in compliance with Desired configuration. This class attribute +was added in vSphere API 8.0.1.0.

+
+ +
+
+NON_COMPLIANT = ComplianceStatus(string='NON_COMPLIANT')
+

ESXi host is not in compliance with Desired configuration. This class +attribute was added in vSphere API 8.0.1.0.

+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ConfigurationSpec(spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConfigurationSpec class contains attributes that describe the +desired configuration that is associated with a cluster. This class was +added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

spec (str) – Desired configuration document. This attribute was added in vSphere +API 8.0.1.0.

+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.DependencyError(required_value=None, current_value=None, possible_values=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DependencyError class contains details of the validation error +caused by dependency between different properties in the configuration. +This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • required_value (str) – The dependency required by a union tag. This attribute was added in +vSphere API 8.0.2.0.

    • +

  • current_value (str or None) – This attribute was added in vSphere API 8.0.2.0. +If set, it contains the current value of the dependency +property.

    • +

  • possible_values (str) – The possible values of the dependency property that are compatible +with this property. This attribute was added in vSphere API +8.0.2.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError(hosts=None, message=None, type=None, pattern=None, expected_type=None, instance_id=None, property_name=None, maximum_length=None, minimum_length=None, maximum_value=None, minimum_value=None, dependency_error=None, component=None, group=None, key=None, path=None, required_property=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SchemaValidationError class contains details of validation errors +for a property. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class ErrorType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DetailedValidationError.ErrorType enum contains the possible types +of errors related to property validation. This enumeration was added in +vSphere API 8.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ErrorType instance.

+
+
+
+
+ADDITIONAL_PROPERTY = ErrorType(string='ADDITIONAL_PROPERTY')
+

A property that is not specified in the schema was found. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+DUPLICATE_INSTANCE_ID = ErrorType(string='DUPLICATE_INSTANCE_ID')
+

An instance has an instance ID that was already used in another instance. +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+EMPTY_PROPERTY = ErrorType(string='EMPTY_PROPERTY')
+

An object or array property is empty. This class attribute was added in +vSphere API 8.0.2.0.

+
+ +
+
+GENERIC = ErrorType(string='GENERIC')
+

A generic error. Check the message property for more information. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+HOST_SPECIFIC_IN_PROFILE = ErrorType(string='HOST_SPECIFIC_IN_PROFILE')
+

The property is host-specific, but was found in the profile section. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+HOST_SPECIFIC_KEY_IN_OVERRIDE = ErrorType(string='HOST_SPECIFIC_KEY_IN_OVERRIDE')
+

A host-specific configuration was found in the host-override section. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+INVALID_DELETE_DEFAULT = ErrorType(string='INVALID_DELETE_DEFAULT')
+

The property is only valid for mutable default configurations. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+INVALID_ENUM_OPTION = ErrorType(string='INVALID_ENUM_OPTION')
+

The value of an enum property does not match one of the allowed values. +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+INVALID_TYPE = ErrorType(string='INVALID_TYPE')
+

The value of a property is not the expected type. This class attribute was +added in vSphere API 8.0.2.0.

+
+ +
+
+INVALID_UNION_TAG = ErrorType(string='INVALID_UNION_TAG')
+

A property that is dependent on another property is invalid. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+KEY_IN_HOST_OVERRIDE = ErrorType(string='KEY_IN_HOST_OVERRIDE')
+

The configuration exists in both host-override and host-specific sections. +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MAX_ARRAY_LENGTH = ErrorType(string='MAX_ARRAY_LENGTH')
+

The length of an array is larger than the maximum allowed. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MAX_STRING_LENGTH = ErrorType(string='MAX_STRING_LENGTH')
+

The length of a string is larger than the maximum allowed. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MAX_VALUE = ErrorType(string='MAX_VALUE')
+

The value of a numeric property is larger than the maximum allowed. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MIN_ARRAY_LENGTH = ErrorType(string='MIN_ARRAY_LENGTH')
+

The length of an array is smaller than the minimum allowed. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MIN_STRING_LENGTH = ErrorType(string='MIN_STRING_LENGTH')
+

The length of a string is smaller than the minimum allowed. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MIN_VALUE = ErrorType(string='MIN_VALUE')
+

The value of a numeric property is smaller than the minimum allowed. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+MISSING_INSTANCE_ID = ErrorType(string='MISSING_INSTANCE_ID')
+

An instance does not have the required ID property. This class attribute +was added in vSphere API 8.0.2.0.

+
+ +
+
+MISSING_REQUIRED = ErrorType(string='MISSING_REQUIRED')
+

A required property is missing. This class attribute was added in vSphere +API 8.0.2.0.

+
+ +
+
+MISSING_REQUIRED_PROFILE_INSTANCE = ErrorType(string='MISSING_REQUIRED_PROFILE_INSTANCE')
+

The host-specific configuration refers to an instance that does not exist +in the profile section. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+
+MISSING_REQUIRED_PROFILE_KEY = ErrorType(string='MISSING_REQUIRED_PROFILE_KEY')
+

The host-specific configuration refers to a configuration key that does not +exist in the profile section. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+
+NOT_HOST_SPECIFIC = ErrorType(string='NOT_HOST_SPECIFIC')
+

The property is not host-specific, but was found in the host-specific +section. This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+NULL_VALUE = ErrorType(string='NULL_VALUE')
+

A property has a null value. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+
+PATTERN_MISMATCH = ErrorType(string='PATTERN_MISMATCH')
+

The value of a string property does not match the allowed pattern. This +class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+PLACEHOLDER_FOUND = ErrorType(string='PLACEHOLDER_FOUND')
+

The property contains a placeholder that must be replaced. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+PROPERTY_NAME_MISMATCH = ErrorType(string='PROPERTY_NAME_MISMATCH')
+

A property name does not match the required pattern. This class attribute +was added in vSphere API 8.0.2.0.

+
+ +
+
+SCHEMA_NOT_FOUND = ErrorType(string='SCHEMA_NOT_FOUND')
+

A configuration was found for software that is not in the image associated +with the cluster. This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+UNION_CASE_WITHOUT_UNION_TAG = ErrorType(string='UNION_CASE_WITHOUT_UNION_TAG')
+

A union-case property was provided, but the corresponding union tag +property was not set. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.DocumentStructure(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DocumentStructure class contains the possible structures of the +configuration document. This enumeration was added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DocumentStructure instance.

+
+
+
+
+HOST_ORIENTED = DocumentStructure(string='HOST_ORIENTED')
+

The host-specific portions of the document are stored in the +“host-specific” object at the top-level with entries for each host, +organized by the host’s BIOS UUID. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+
+PROFILE_ORIENTED = DocumentStructure(string='PROFILE_ORIENTED')
+

The host-specific portions of the document are distributed through the +“profile” object hierarchy. Each property that is host-specific will be an +object with entries for each host where the property is defined. The hosts +in the object are organized by BIOS UUID. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.DraftImportResult(status=None, draft=None, error=None, warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DraftImportResult class contains attributes that describe the +result of importing the desired configuration for a cluster into a draft.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (DraftImportResult.Status) – Status of importing desired configuration.

    • +

  • draft (str) – This identifier refers to the commit action of importing the +desired configuration document. This identifier can be used in the +apply API. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.draft. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.draft. +This attribute is optional and it is only relevant when the value +of status is DraftImportResult.Status.OK.

    • +

  • error (com.vmware.vapi.std_client.LocalizableMessage) – Localized message describing the error encountered while importing +desired configuration. The import operation will fail if the +configuration document is an invalid JSON. +This attribute is optional and it is only relevant when the value +of status is DraftImportResult.Status.ERROR.

    • +

  • warnings (list of com.vmware.vapi.std_client.LocalizableMessage or None) – Any issues found during the import are reported in this list.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DraftImportResult.Status class contains the possible status codes +describing the result of importing desired configuration for a cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+CANCELED = Status(string='CANCELED')
+
+ +
+
+ERROR = Status(string='ERROR')
+

Desired configuration import failed with error.

+
+ +
+
+OK = Status(string='OK')
+

Desired configuration imported successfully.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The task is in-progress.

+
+ +
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.Drafts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Drafts class provides methods to manage cluster configuration +drafts. This class was added in vSphere API 8.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyResult(commit=None, apply_task=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ApplyResult class contains the result of committing a draft. +This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • commit (str) – The ID of the commit created for this operation. This attribute was +added in vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • apply_task (str or None) – If the cluster is not empty, this will be set to the ID of the +Apply task. This attribute was added in vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task.

    • +
+
+
+
+ +
+
+class ApplySpec(message=None, apply_policy_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ApplySpec class contains attributes that are used to create +a new commit. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • message (str or None) – Message to include with the commit. This attribute was added in +vSphere API 8.0.2.0. +If None, message is set to empty string.

    • +

  • apply_policy_spec (com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec or None) – The parameter can be used to override the default remediation +policies for the apply task. This attribute was added in vSphere +API 8.0.2.0. +if None the default cluster remediation policies are used.

    • +
+
+
+
+ +
+
+class ChangeDetails(modified_properties=None, deleted_properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ChangeDetails class contains information about changes made +in the draft when compared against the current desired document. This class +was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • modified_properties (dict of str and Drafts.ModificationInfo) – Captures the properties that were added/modified in this draft. The +map keys are JSON-Pointers that refer to the properties in the +draft that are modifications. The values contain information about +the property and, in the case of a modification, the location of +the corresponding property in the desired document. This attribute +was added in vSphere API 8.0.2.0.

    • +

  • deleted_properties (dict of str and Drafts.DeletionInfo) – Captures the properties that were deleted from this draft. The map +keys are JSON-Pointers that refer to the properties in the desired +document that were deleted. This attribute was added in vSphere API +8.0.2.0.

    • +
+
+
+
+ +
+
+class ChangedProperty(path=None, current=None, draft=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ChangedProperty class contains information about a property +that is different in this draft from the committed configuration. This +class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) – A JSON-Pointer that refers to the property that has been changed. +This attribute was added in vSphere API 8.0.2.0.

    • +

  • current (str or None) – This attribute was added in vSphere API 8.0.2.0. +If set, the current value of the property in the cluster +configuration. If not set, the property does not exist in the +current cluster configuration.

    • +

  • draft (str or None) – This attribute was added in vSphere API 8.0.2.0. +If set, this is the new value for the property in this draft. If +not set, the property has been deleted in this draft.

    • +
+
+
+
+ +
+
+class ChangesResult(sets=None, adds=None, deletes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ChangesResult class contains a detailed description of the +differences between this draft and the current desired configuration. This +class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • sets (list of Drafts.ChangedProperty or None) – This attribute was added in vSphere API 8.0.2.0. +If set, this contains a list of properties that have been changed +from one value to another in this draft.

    • +

  • adds (list of Drafts.ChangedProperty or None) – This attribute was added in vSphere API 8.0.2.0. +If set, this contains a list of properties that have been added in +this draft.

    • +

  • deletes (list of Drafts.ChangedProperty or None) – This attribute was added in vSphere API 8.0.2.0. +If set, this contains a list of properties that have been deleted +in this draft.

    • +
+
+
+
+ +
+
+class ConflictDetails(properties=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

properties (dict of str and Drafts.ConflictPropertyInfo) – Map of properties in the current draft that were changed and +conflict with changes that were applied to the cluster +configuration document since this draft was created. This attribute +was added in vSphere API 8.0.2.0.

+
+
+
+ +
+
+class ConflictPropertyInfo(property_path=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ConflictPropertyInfo class contains information about +conflicts that have been detected when attempting to merge configuration +changes that have been committed by other users. This class was added in +vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

property_path (str) – The path refers to the conflicting property in the cluster +configuration document. This attribute was added in vSphere API +8.0.2.0.

+
+
+
+ +
+
+class CreateSpec(config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.CreateSpec class contains information used when creating a +draft. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

config (str or None) – The initial configuration for the draft. This attribute was added +in vSphere API 8.0.2.0. +If not specified, the current desired configuration for the cluster +will be used.

+
+
+
+ +
+
+class DeletionInfo(display_path=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.DeletionInfo class contains information about a property +that was deleted from the draft configuration. This class was added in +vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

display_path (list of str) – A list of the display names for components of the property path. +This attribute was added in vSphere API 8.0.2.0.

+
+
+
+ +
+
+class Info(metadata=None, errors=None, changes=None, conflicts=None, host_info=None, host_id_to_uuid=None, config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Info class defines the information about configuration +draft. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • metadata (Drafts.Metadata) – Metadata about the configuration draft. This attribute was added in +vSphere API 8.0.2.0.

    • +

  • errors (Drafts.ValidationDetails or None) – This attribute was added in vSphere API 8.0.2.0. +If set, there were validation errors detected in the draft +configuration.

    • +

  • changes (Drafts.ChangeDetails or None) – This attribute was added in vSphere API 8.0.2.0. +If set, there are changes in this draft configuration from the +current desired configuration.

    • +

  • conflicts (Drafts.ConflictDetails or None) – This attribute was added in vSphere API 8.0.2.0. +If set, there are changes in this draft configuration that conflict +with changes applied by a different user.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – A mapping of BIOS UUIDs for every host in the cluster to +information about that host. The host-specific/host-override +sections of the configuration use BIOS UUIDs to identify hosts, so +this information can be useful to get details about hosts mentioned +there. This attribute was added in vSphere API 8.0.2.0.

    • +

  • host_id_to_uuid (dict of str and str) – Map of host IDs to BIOS UUIDs. This attribute was added in vSphere +API 8.0.2.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • config (str) – Configuration specification associated with the draft, encoded as +JSON. This attribute was added in vSphere API 8.0.2.0.

    • +
+
+
+
+ +
+
+class Metadata(id=None, parent_id=None, owner=None, state=None, revision=None, creation_time=None, modified_time=None, precheck_task=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Metadata class defines the metadata information about +configuration draft. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The draft identifier. This attribute was added in vSphere API +8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.draft. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.draft.

    • +

  • parent_id (str) – The identifier of the parent commit. This attribute was added in +vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • owner (str) – Owner of the configuration draft. This attribute was added in +vSphere API 8.0.2.0.

    • +

  • state (Drafts.State) – State of the configuration draft. This attribute was added in +vSphere API 8.0.2.0.

    • +

  • revision (long) – The current revision of this draft. Any updates to the draft will +increment this value. This value should be included in calls to +Drafts.update() so that concurrent changes can be detected. +This attribute was added in vSphere API 8.0.2.0.

    • +

  • creation_time (datetime.datetime) – Creation time of the configuration draft. This attribute was added +in vSphere API 8.0.2.0.

    • +

  • modified_time (datetime.datetime) – Last modified time of the configuration draft. This attribute was +added in vSphere API 8.0.2.0.

    • +

  • precheck_task (str or None) – The ID of the precheck task that was last run for this draft. This +attribute was added in vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This field is None if precheck has not been done since the last +modification.

    • +
+
+
+
+ +
+
+class ModificationInfo(display_path=None, original_path=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ModificationInfo class contains information about a +modification to a property in the configuration. This class was added in +vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_path (list of str) – A list of the display names for components of the property path. +This attribute was added in vSphere API 8.0.2.0.

    • +

  • original_path (str or None) – This attribute was added in vSphere API 8.0.2.0. +If set, it contains a JSON-Pointer to the corresponding property in +the original document. Otherwise, this modification is an addition +to the draft.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.draft'
+

Resource type for draft resource. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The states of the draft configuration. This enumeration was added in +vSphere API 8.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+INVALID = State(string='INVALID')
+

Configuration draft is invalid. This class attribute was added in vSphere +API 8.0.2.0.

+
+ +
+
+VALID = State(string='VALID')
+

Configuration draft is valid. This class attribute was added in vSphere API +8.0.2.0.

+
+ +
+ +
+
+class UpdateSpec(expected_revision=None, config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.UpdateSpec class contains the new configuration for the +draft. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • expected_revision (long or None) – When supplied, this revision value will be compared against the +draft’s current revision as returned in +Drafts.Metadata.revision to ensure no other changes have +been applied. This attribute was added in vSphere API 8.0.2.0.

    • +

  • config (str) – The new cluster configuration for this draft, encoded as JSON. This +attribute was added in vSphere API 8.0.2.0.

    • +
+
+
+
+ +
+
+class ValidationDetails(errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ValidationDetails class contains all validation errors +related to the draft configuration. This class was added in vSphere API +8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

errors (dict of str and Drafts.ValidationErrors) – Map of JSON-Pointers to properties in the draft configuration that +have validation errors based on the schema and host-level +validations. This attribute was added in vSphere API 8.0.2.0.

+
+
+
+ +
+
+class ValidationErrors(display_path=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ValidationErrors class contains schema-based validation +errors for a given property. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_path (list of str) – A list of the display names for components of the property path. +This attribute was added in vSphere API 8.0.2.0.

    • +

  • errors (list of DetailedValidationError) – Localized error message describing the validation error. This +attribute was added in vSphere API 8.0.2.0.

    • +
+
+
+
+ +
+
+apply(cluster, draft, spec=None)
+

Commit this draft and make it the new desired configuration for the +cluster. The draft must be in the Drafts.State.VALID state for +this method to succeed. A successful commit will result in the draft +being deleted. If the cluster is not empty, the Apply API will be +called with the new desired state. This method was added in vSphere API +8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (Drafts.ApplySpec or None) – Additional arguments for the operation.

    • +
+
+
Return type
+

Drafts.ApplyResult

+
+
Returns
+

A structure that contains the ID of the new commit and, if an +ApplySpec was supplied, the ID of the Apply task.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the draft is not in the Drafts.State.VALID state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Remediate.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Remediate.

    • +
+
+
+
+ +
+
+check_compliance_task(cluster, draft)
+

Check all the hosts in the cluster for compliance with the +configuration specified in the draft. This method was added in vSphere +API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If an internal error occurred. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If API is called on a cluster that is not managed by desired +configuration management platform.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the API timed out before completion.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+create(cluster, spec=None)
+

Create a new draft with the given values. If a configuration is +supplied in the spec, it will be used as the initial value. Otherwise, +the current desired configuration will be used as the initial value. +The Drafts.Metadata.owner field will be set to the caller’s +user ID and the Drafts.Metadata.parent_id will be set to the +current commit ID for the cluster. This method was added in vSphere API +8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Drafts.CreateSpec or None) – Options used when creating the new draft.

    • +
+
+
Return type
+

str

+
+
Returns
+

The return value will be an identifier for the resource type: +com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If there is already a draft by this author for this cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the supplied configuration is not valid JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+
+delete(cluster, draft)
+

Delete this draft. Any changes will be abandoned. This method was added +in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+
+export_config(cluster, draft)
+

This API will export the draft configuration associated with the +cluster. This method was added in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster on which operation should be performed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

ExportResult

+
+
Returns
+

This output structure of type +com.vmware.esx.settings.clusters.Configuration#ExportResult +contains the configuration document encoded as JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Export.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Export.

    • +
+
+
+
+ +
+
+get(cluster, draft)
+

Get the cluster configuration and related metadata from this draft. +This method was added in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

Drafts.Info

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+
+import_from_host_task(cluster, draft, host)
+

The API imports the desired configuration from a reference host in the +cluster. The API also adds host-specific and host-overrides from the +other hosts in the cluster. Import API does not validate the +configuration against the schema. The result will specify if the +configuration was imported successfully. The result will provide +localized error message if the import operation failed. This method was +added in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • host (str) – Identifier of the reference host +The parameter must be an identifier for the resource type: +HostSystem.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+list(cluster)
+

Get the active drafts for this cluster. This method was added in +vSphere API 8.0.2.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

dict of str and Drafts.Metadata

+
+
Returns
+

Map of drafts keyed by their identifiers. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+
+precheck_task(cluster, draft)
+

This API will perform impact analysis of the configuration specified in +the draft on each of the hosts in the cluster. The API will check +against the desired image schema whether the desired configuration has +added any requirements for the host to be put in maintenance mode or to +be rebooted. The API will also invoke plugins which will validate the +configuration on each hosts in the cluster. If the configuration is +valid the API will also detect if the host needs to be maintenance mode +or to be rebooted. If the hosts requires maintenance mode or reboot, +then the API will run health checks to see the hosts can be put into +the maintenance mode based on their current state. If any host cannot +be put into maintenance mode due to health errors, then those errors +will be reported in the result. The result will also list the +configurations that will change on applying the configuration in the +draft. This method was added in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – The cluster on which to perform impact analysis. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+show_changes(cluster, draft)
+

Get the differences between this draft and the current desired state +for the cluster. This method was added in vSphere API 8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

Drafts.ChangesResult

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+
+update(cluster, draft, spec)
+

Replace the current configuration in this draft with the supplied one. +If the supplied configuration is different from the current value, the +Drafts.Metadata.precheck_task fields will be cleared. If an +expected revision number is provided, it must match the current +revision of this draft or a ConcurrentChange exception will be raised. +If no expected revision number is provided, this check will be skipped +and the update will go through. This method was added in vSphere API +8.0.2.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (Drafts.UpdateSpec) –

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the supplied configuration is not valid JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ConcurrentChange +If the expectedRevision in the spec differs from the draft’s +current revision.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ExportResult(config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This ExportResult class contains attributes that describe the result of +exporting configuration from the cluster. This class was added in vSphere +API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

config (str) – Configuration of the cluster encoded as JSON. This attribute was +added in vSphere API 8.0.1.0.

+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.HostCompliance(status=None, compliance_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostCompliance class contains attributes that describe compliance +information for the ESXi host on which the Check Compliance operation +completed successfully. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – This field indicates whether the ESXi host is compliant with the +desired configuration specified in +com.vmware.esx.settings_daemon.Configuration#CheckComplianceSpec. +If COMPLIANT, no other information is available. If NON_COMPLAINT, +drift information can be fetched from {#ComplianceInfo}. This +attribute was added in vSphere API 8.0.1.0.

    • +

  • compliance_info (ComplianceInfo) – Settings compliance information generated by the CheckCompliance +operation. This attribute was added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is ComplianceStatus.NON_COMPLIANT.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.HostPrecheckResult(status=None, summary=None, validation_errors=None, impact=None, precheck_result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This HostPrecheckResult class contains attributes that describes the +Precheck API result on a host. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (HostStatus) – This field represents the status of the precheck request for this +host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was +not completed on the host due to some error or if health checks +failed. If precheck failed due to host validation errors, details +are specified in HostPrecheckResult.validation_errors. If +precheck failed due to generic error, details are specified in the +HostPrecheckResult.summary. Health check result is +specified in HostPrecheckResult.precheck_result. This +attribute was added in vSphere API 8.0.1.0.

    • +

  • summary (com.vmware.vapi.std_client.LocalizableMessage) – Summarizing precheck operation on the host. This attribute was +added in vSphere API 8.0.1.0.

    • +

  • validation_errors (list of ValidationError or None) – This field represents the validation errors if the desired +configuration specified is not valid. This attribute was added in +vSphere API 8.0.1.0. +This field is set if #HostStatus#status is ERROR due to +host returning validation errors.

    • +

  • impact (ImpactInfo or None) – This field represents the impact on the host to reach the desired +configuration state. This attribute was added in vSphere API +8.0.1.0. +This field is set if there are no validation errors on the +host. The HostStatus.status may be OK or ERROR.

    • +

  • precheck_result (com.vmware.esx.settings_client.StatusInfo or None) – This field represents the health check results from the host, if +the host needs to be put in maintenance mode or to be rebooted. +This attribute was added in vSphere API 8.0.1.0. +This field is set if there are not validation errors and +health checks are run on the host. The HostStatus.status +may be OK or ERROR.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.HostResult(host_status=None, summary=None, errors=None, host_compliance=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This HostResult class contains attributes that describe the result of +the check compliance operation on an ESXi host. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host_status (HostStatus) – This field represents the status of the check compliance operation. +If status is OK, the result of operation can be retrived from +{#HostCompliance} {#Summary} field will summarize the status of the +operation and if applicable, the specific error that occured. +Additionally, {#ValidationError} is populated if the operation +fails due to host validation errors in desired document. This +attribute was added in vSphere API 8.0.1.0.

    • +

  • summary (com.vmware.vapi.std_client.LocalizableMessage) – Summary of check compliance operation on the host. This attribute +was added in vSphere API 8.0.1.0.

    • +

  • errors (list of ValidationError or None) – List of validation errors returned by the host. This is only set +for a specific HostStatus ERROR case. This attribute was added in +vSphere API 8.0.1.0. +This field is set only if the document fails to validate +on the host.

    • +

  • host_compliance (HostCompliance or None) – This field provides compliance results for the host if the +operation successfully completed on the host. That is, this field +is populated only if HostStatus is OK. This attribute was added in +vSphere API 8.0.1.0. +This field is None if check compliance could not be completed on +the host.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.HostStatus(status=None, attempts=None, remaining_retries=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostStatus class contains attributes that describe the status of an +method. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (HostStatus.Status) – The status of the method. This attribute was added in vSphere API +8.0.1.0.

    • +

  • attempts (long or None) – Number of the performed attempts of the method. This attribute was +added in vSphere API 8.0.1.0. +This field is None if it is not applicable.

    • +

  • remaining_retries (long or None) – Number of the remaining attempts of the method. This attribute was +added in vSphere API 8.0.1.0. +This field is None if it is not applicable.

    • +

  • start_time (datetime.datetime) – Time when the method started. This attribute was added in vSphere +API 8.0.1.0.

    • +

  • end_time (datetime.datetime) – Time when the method completed. This attribute was added in vSphere +API 8.0.1.0.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of +the method. This attribute was added in vSphere API 8.0.1.0.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The HostStatus.Status class contains the possible different status +codes that can be returned while trying to perform an operation on the +hosts within the cluster. This enumeration was added in vSphere API +8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+CANCELED = Status(string='CANCELED')
+

The method was canceled. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error. This class attribute was added +in vSphere API 8.0.1.0.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully. This class attribute was added in +vSphere API 8.0.1.0.

+
+ +
+
+PENDING = Status(string='PENDING')
+

The method is pending. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+
+RETRY_PENDING = Status(string='RETRY_PENDING')
+

The method is pending a retry. This class attribute was added in vSphere +API 8.0.1.0.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The method is in progress. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ImpactInfo(impact=None, info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This ImpactInfo class contains attributes that describes the Impact if +the host is not compliant against the desired configuration. This class was +added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (ImpactType) – This field indicates the ESXi host impact on applying the desired +configuration. This attribute was added in vSphere API 8.0.1.0.

    • +

  • info (list of com.vmware.vapi.std_client.LocalizableMessage) – This field represents the list of impact information describing the +configuration changes needed on the host to reach the desired +state. This attribute was added in vSphere API 8.0.1.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ImpactType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ImpactType class contains information about the impact of applying +desired configuration on the ESXi host. This enumeration was added in +vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ImpactType instance.

+
+
+
+
+MAINTENANCE_MODE_REQUIRED = ImpactType(string='MAINTENANCE_MODE_REQUIRED')
+

Host requires maintenance mode to reach the desired state. This class +attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+NO_IMPACT = ImpactType(string='NO_IMPACT')
+

Host has no impact. This class attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+REBOOT_REQUIRED = ImpactType(string='REBOOT_REQUIRED')
+

Host requires reboot to reach the desired state. This class attribute was +added in vSphere API 8.0.1.0.

+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ImportResult(status=None, commit=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This ImportResult class contains attributes that describe the result of +importing a configuration document in the cluster. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ImportResult.Status) –

    • +

  • commit (str) – This identifier refers to the commit action of importing the +desired configuration document. This identifier can be used in the +apply API. This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +This attribute is optional and it is only relevant when the value +of status is ImportResult.Status.OK.

    • +

  • errors (list of ValidationError) – Lists all validation errors identified in the configuration +document. This attribute was added in vSphere API 8.0.1.0. +This is set when #success is false.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

This enum indicates whether the configuration document was imported +successfully in the cluster. This enumeration was added in vSphere API +8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+CANCELED = Status(string='CANCELED')
+
+ +
+
+ERROR = Status(string='ERROR')
+
+ +
+
+OK = Status(string='OK')
+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The task is in-progress. This class attribute was added in vSphere API +8.0.1.0.

+
+ +
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.Schema(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Schema class provides methods to manage the desired configuration +schema of an ESX cluster. This class was added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

Returns the configuration schema associated with the cluster. This +method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

SchemaResult

+
+
Returns
+

The schema associated with the cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +In case of an unknown internal error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster is invalid

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the schema associated with the cluster is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is unavailable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the session is unauthenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.SchemaResult(schema=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SchemaResult class contains attributes that describe the +configuration schema associated with the cluster. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

schema (str) – The configuration schema associated with the cluster. This +attribute was added in vSphere API 8.0.1.0.

+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.SettingCompliance(path=None, current=None, target=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SettingCompliance class contains attributes that describe a drift +in an ESXi host setting. This structure is used to describe either a change +in configuration value(set) or addition of configuration or deletion of +configuration. When used to describe addition or deletion of a setting, +only the path is set. When used to describe a set operation, current and +target values are set only if drift is in a property that is of primitive +type. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) – Full path to the setting within the desired document. This +attribute was added in vSphere API 8.0.1.0.

    • +

  • current (str or None) – Value of setting on the ESXi host. This attribute was added in +vSphere API 8.0.1.0. +This field is None if there is no host value to report or if +setting is of complex type.

    • +

  • target (str or None) – Value of setting in the desired document. This attribute was added +in vSphere API 8.0.1.0. +This field is None if there is no value in the desired document to +report or if setting is of complex type.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ValidationError(path=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ValidationError class contains attributes that describes a +validation error in the configuration. This class was added in vSphere API +8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) – Full path to the configuration or the property within the +configuration which was found to be invalid. This attribute was +added in vSphere API 8.0.1.0.

    • +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) – Localized error message describing the validation error. This +attribute was added in vSphere API 8.0.1.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.configuration_client.ValidationResult(valid=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This ValidationResult class contains attributes that describe the +result of validating a configuration document. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • valid (bool) – This boolean flag indicates whether the configuration document +validated successfully with no validation errors. This attribute +was added in vSphere API 8.0.1.0.

    • +

  • errors (list of ValidationError or None) – Lists all validation errors identified in the configuration +document. This attribute was added in vSphere API 8.0.1.0. +This is set when ValidationResult.valid is false.

    • +
+
+
+
+ +
+
+

com.vmware.esx.settings.clusters.enablement_client module

+

The com.vmware.esx.settings.clusters.enablement_client module provides +classes to manage enablement of the feature that allows to collectively manage +hosts within the cluster with a single software specification.

+
+
+class com.vmware.esx.settings.clusters.enablement_client.Configuration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Configuration class provides methods to control whether the cluster +is managed using desired configuration platform semantics. This class was +added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configuration.Info class contains information describing whether +the feature is enabled. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool) – Status of the feature enablement True if feature is enabled, false +otherwise. This attribute was added in vSphere API 8.0.1.0.

+
+
+
+ +
+
+get(cluster)
+

Returns whether the given cluster is managed using a desired +configuration plaftorm. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Configuration.Info

+
+
Returns
+

Information about the feature enablement.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.enablement_client.Software(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Software class provides methods to control whether the cluster is +managed with a single software specification.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckResult class contains information that describes the +results of the checks.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (dict of Software.CheckType and com.vmware.esx.settings_client.Notifications) – Notifications containing check results grouped by +Software.CheckType type.

+
+
+
+ +
+
+class CheckSpec(checks_to_skip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckSpec class contains information describing what +checks should be performed.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

checks_to_skip (set of Software.CheckType) – Specifies the checks that should be skipped. If the set is +empty, all checks will be performed.

+
+
+
+ +
+
+class CheckType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.CheckType class contains various checks to identify the +possibility to enable the feature that manages the cluster with a single +software specification.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CheckType instance.

+
+
+
+
+SOFTWARE = CheckType(string='SOFTWARE')
+

Perform host software check. This check is to report standalone VIBs (VIBs +which are not part of any component) and the features on the given cluster +that cannot coexist with the feature which manages the cluster with a +single software specification.

+
+ +
+
+SOFTWARE_SPECIFICATION_EXISTENCE = CheckType(string='SOFTWARE_SPECIFICATION_EXISTENCE')
+

Perform cluster’s software specification existence check.

+
+ +
+
+STATELESSNESS = CheckType(string='STATELESSNESS')
+

Perform host statelessness check. This feature does not support stateless +hosts.

+
+ +
+
+VERSION = CheckType(string='VERSION')
+

Perform host version check. This feature does not support hosts with +version less than XYZ.

+
+ +
+
+VSAN_WITNESS_ELIGIBILITY = CheckType(string='VSAN_WITNESS_ELIGIBILITY')
+

Checks to verify if the cluster software specification can be used to +manage any vSAN witness hosts in the cluster. This class attribute was +added in vSphere API 7.0.2.1.

+
+ +
+
+VUM_REMEDIATION = CheckType(string='VUM_REMEDIATION')
+

Perform VUM active remediation check.

+
+ +
+ +
+
+class EnableSpec(skip_software_check=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.EnableSpec class contains information describing checks +that should be skipped during enablement. Currently only +Software.CheckType.SOFTWARE check can be skipped.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

skip_software_check (bool) – Skip Software.CheckType.SOFTWARE check during feature +enablement.

+
+
+
+ +
+
+class Info(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.Info class contains information describing whether the +feature is enabled.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool) – Status of the feature enablement True if feature is enabled, false +otherwise

+
+
+
+ +
+
+check_task(cluster, spec=None)
+

Checks the possibility to manage the cluster with a single software +specification.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Software.CheckSpec or None) – Check specification. +If None, all checks are performed.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the feature is already enabled for the given cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+enable_task(cluster, spec=None)
+

Enables the feature which manages the cluster with a single software +specification.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Software.EnableSpec or None) – Enablement specification. +If None, all checks are performed.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If feature enablement failed for the given cluster. The value of +the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +Software.CheckResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the feature is already enabled for the given cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+get(cluster)
+

Returns whether the given cluster is managed with a single software +specification.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Software.Info

+
+
Returns
+

Information about the feature enablement.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.enablement_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.clusters.policies_client module

+

The com.vmware.esx.settings.clusters.policies_client module provides +classes to manage policies that affect management of desired state +configuration and software for an ESXi cluster. Copyright 2019-2023 VMware, +Inc. All rights reserved. VMware Confidential Copyright 2020-2021 VMware, Inc. +All rights reserved. VMware Confidential

+
+
+class com.vmware.esx.settings.clusters.policies_client.Apply(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Apply class provides methods to configure the policies that will +impact how the software and configuration specification documents are +applied to an ESXi cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfiguredPolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None, disable_dpm=None, disable_hac=None, evacuate_offline_vms=None, enforce_hcl_validation=None, parallel_remediation_action=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.ConfiguredPolicySpec class contains attributes that describe +the policies configured to be used when the software and configuration +specification documents are applied to an ESXi cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Apply.FailureAction or None) – What action is to be taken if entering maintenance mode fails on a +given host of the cluster. +If None, configured value would be unset.

    • +

  • pre_remediation_power_action (Apply.ConfiguredPolicySpec.PreRemediationPowerAction or None) – Specifies what should be done to the power state of the VM before +entering maintenance mode. +If None, configured value would be unset.

    • +

  • enable_quick_boot (bool or None) – Enable Quick Boot during remediation in the cluster. +If None, configured value would be unset.

    • +

  • disable_dpm (bool or None) – Disable DPM on the cluster. +If None, configured value would be unset.

    • +

  • disable_hac (bool or None) – Disable HA Admission control on the cluster. +If None, configured value would be unset.

    • +

  • evacuate_offline_vms (bool or None) – Evacuate powered off/suspended VMs when attempting maintenance +mode. +If None, configured value would be unset.

    • +

  • enforce_hcl_validation (bool or None) – Enforce Hcl validation, when applicable, to prevent remediation if +hardware compatibility issues are found. This attribute was added +in vSphere API 7.0.1.0. +If None, hardware compatibility issues will not prevent +remediation.

    • +

  • parallel_remediation_action (Apply.ParallelRemediationAction or None) – Enable parallel remediation of hosts in maintenance mode. Set max +hosts when applicable. This attribute was added in vSphere API +8.0.0.1. +If None, parallel remediation will not happen.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.ConfiguredPolicySpec.PreRemediationPowerAction class defines +the possible actions to be taken, before entering maintenance mode.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on a single host +within the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Apply.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on a single host within the cluster.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.FailureAction.Action class defines the actions to be taken +when entering maintenance mode fails on a single host within the cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction.retry_count number of times on +the failed host after Apply.FailureAction.retry_delay.

+
+ +
+ +
+ +
+
+class ParallelRemediationAction(enabled=None, max_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Enable parallel remediation for hosts in maintenance mode within a +cluster. This attribute was added in vSphere API 8.0.0.1.

    • +

  • max_hosts (long or None) – Maximum number of hosts that can be remediated in parallel. Setting +Apply.ParallelRemediationAction.max_hosts does not +guarantee maxHosts to be remediated in parallel. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+get(cluster)
+

Returns the configured policy that has been set for the cluster.

+
+
Parameters
+

cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Apply.ConfiguredPolicySpec

+
+
Returns
+

The configured policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+set(cluster, spec)
+

This API will set the configured policy specification for the cluster.

+
+
Parameters
+
    +

  • cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Apply.ConfiguredPolicySpec) – The policy that needs to be configured.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If invalid value is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.policies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.clusters.software_client module

+

The com.vmware.esx.settings.clusters.software_client module provides +classes to manage desired state software for ESX cluster.

+
+
+class com.vmware.esx.settings.clusters.software_client.AddOn(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AddOn class provides methods to manage desired OEM add-on +specification for a given cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'
+

Resource type for add-on resource

+
+ +
+
+get(cluster)
+

Returns the desired OEM add-on specification for a given cluster.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings_client.AddOnInfo

+
+
Returns
+

Desired OEM add-on specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired OEM add-on specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.BaseImage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The BaseImage class provides methods to manage desired ESX base image.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'
+

Resource type for base-image resource

+
+ +
+
+get(cluster)
+

Returns the desired base-image specification set for given cluster

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings_client.BaseImageInfo

+
+
Returns
+

Base-image specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.Commits(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Commits class provides methods to manage committed changes to +desired software document.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(author=None, commit_time=None, description=None, apply_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Commits.Info class defines the information about software draft.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • author (str) – Author of the commit.

    • +

  • commit_time (datetime.datetime) – Creation time of the commit.

    • +

  • description (str) – Description accompanying this commit.

    • +

  • apply_status (Commits.Info.ApplyStatusType) – Apply status of the commit.

    • +
+
+
+
+
+class ApplyStatusType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Commits.Info.ApplyStatusType class defines possible values +regarding the application of this commit.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplyStatusType instance.

+
+
+
+
+APPLIED = ApplyStatusType(string='APPLIED')
+

Commit has been applied to the cluster.

+
+ +
+
+NOT_APPLIED = ApplyStatusType(string='NOT_APPLIED')
+

Commit hasn’t been applied to the cluster.

+
+ +
+ +
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.commit'
+

Resource type for commit resource

+
+ +
+
+get(cluster, commit)
+

Returns the information about a specific commit.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • commit (str) – Identifier of the specific commit. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.commit.

    • +
+
+
Return type
+

Commits.Info

+
+
Returns
+

Information about the commit.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired specification commit is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.Compliance(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Compliance class provides methods to get the last software +compliance result for an ESX cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'ClusterComputeResource'
+

Resource type for cluster resource

+
+ +
+
+get(cluster)
+

Returns the compliance state for the cluster

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings_client.ClusterCompliance

+
+
Returns
+

Cluster compliance result.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if the compliance information is unavailable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.Components(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Components class provides methods to get desired component +specification for an ESX cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.component'
+

Resource type for component resource

+
+ +
+
+get(cluster, component)
+

Returns the component version for the given component in the desired +software specification.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.ComponentInfo or None

+
+
Returns
+

Details about the component version. +If None then version is supposed to be chosen based on the +constraints in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If invalid component name is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +or no component associated with component in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+list(cluster)
+

Returns a list of components in the desired software specification.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

dict of str and com.vmware.esx.settings_client.ComponentInfo

+
+
Returns
+

Map of ComponentInfo keyed by the component identifier. If no +version is specified in desired software specification, then +ComponentInfo will not be present for that component. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.Drafts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Drafts class provides methods to manage working copy of software +documents.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CommitSpec(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.CommitSpec class contains attributes that are used to create +a new commit.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (str or None) – Message to include with the commit. +If None, message is set to empty string.

+
+
+
+ +
+
+class FilterSpec(owners=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.FilterSpec class contains attributes used to filter the +results when listing software drafts. See Drafts.list().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

owners (set of str or None) – Owners of the drafts. +If None or empty, drafts from all owners will be returned.

+
+
+
+ +
+
+class ImportSpec(source_type=None, location=None, file_id=None, software_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ImportSpec class defines the information used to import the +desired software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source_type (Drafts.SourceType) – Type of the source to import the desired software specification

    • +

  • location (str) – Location of the software specification file to be imported. +This attribute is optional and it is only relevant when the value +of sourceType is Drafts.SourceType.PULL.

    • +

  • file_id (str) – File identifier returned by the file upload endpoint after file is +uploaded. +This attribute is optional and it is only relevant when the value +of sourceType is Drafts.SourceType.PUSH.

    • +

  • software_spec (str) – The JSON string representing the desired software specification. +This attribute is optional and it is only relevant when the value +of sourceType is Drafts.SourceType.JSON_STRING.

    • +
+
+
+
+ +
+
+class Info(metadata=None, software=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Info class defines the information about software draft.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Metadata(owner=None, status=None, creation_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Metadata class defines the metadata information about +software draft.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • owner (str) – Owner of the software draft.

    • +

  • status (Drafts.StatusType) – Status of the software draft.

    • +

  • creation_time (datetime.datetime) – Creation time of the software draft.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.draft'
+

Resource type for draft resource

+
+ +
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Drafts.SourceType class defines possible values of sources to +import software specification.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+CURRENT_SERIES_RECOMMENDATION = SourceType(string='CURRENT_SERIES_RECOMMENDATION')
+

Content is from recommended image specification based on latest base image +patch or update of the current series. For example, a cluster’s current +desired base image is 7.0. Recommendation engine will look into any +recommendable image specification with 7.0 series base images available at +depot manager and try to recommend the highest version within 7.0 series if +possible. Let’s say in this example, depot manager has 7.0 patch a and 7.0 +update 1 base images. Recommendation engine would first validate all +possible images based on 7.0 update 1. If it finds a valid one, it will +store the recommended content with that series. This enum value will point +to that stored recommended image content. Recommendations can be generated +using {\@link: +com.vmware.esx.settings.clusters.software.Recommendations#generate}.

+
+ +
+
+JSON_STRING = SourceType(string='JSON_STRING')
+

The string representing the content of the software specfication.

+
+ +
+
+LATEST_RECOMMENDATION = SourceType(string='LATEST_RECOMMENDATION')
+

Content is from recommended image specification based on latest base image +version. Recommendations can be generated using {\@link: +com.vmware.esx.settings.clusters.software.Recommendations#generate}.

+
+ +
+
+PULL = SourceType(string='PULL')
+

Content is pulled from the URL location. The URL scheme of the value in +{\@link #pullLocation) can be http, https or file.

+
+ +
+
+PUSH = SourceType(string='PUSH')
+

Content was previously uploaded using the file upload enpoint present on +vCenter appliance. This endpoint is present at +https://VCENTERFQDN:9087/vum-fileupload URL.

+
+ +
+
+SPECIFIED_BASE_IMAGE_RECOMMENDATION = SourceType(string='SPECIFIED_BASE_IMAGE_RECOMMENDATION')
+

Content is from recommended image specification based on a specified base +image version. Recommendations can be generated using {\@link: +com.vmware.esx.settings.clusters.software.Recommendations#generate}. This +class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class StatusType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Drafts.StatusType class defines possible values of status of a +software draft.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StatusType instance.

+
+
+
+
+INVALID = StatusType(string='INVALID')
+

Software draft is invalid.

+
+ +
+
+VALID = StatusType(string='VALID')
+

Software draft is valid.

+
+ +
+ +
+
+class Summary(metadata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Summary class defines the summary information about software +draft.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

metadata (Drafts.Metadata) – Metadata about the software draft.

+
+
+
+ +
+
+class ValidateResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ValidateResult class contains attributes to describe result +of validation of desired software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (com.vmware.esx.settings_client.Notifications) – Notifications associated with the validation.

+
+
+
+ +
+
+commit_task(cluster, draft, spec)
+

Commits the specified draft as the desired state document. The result +of this operation can be queried by calling the cis/tasks/{task-id} +where the task-id is the response of this operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the draft. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (Drafts.CommitSpec) – The spec to be used to create the commit.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If validation of the software document fails. The value of the data +attribute of com.vmware.vapi.std.errors_client.Error will +be a class that contains all the attributes defined in +Drafts.ValidateResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+create(cluster)
+

Creates a new software draft from the desired document. It will be +deleted, when the draft is committed successfully. If a desired +document is missing, then this method will create an empty draft.

+
+
Parameters
+

cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the working copy of the document. +The return value will be an identifier for the resource type: +com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If there is already a draft created by this user.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+delete(cluster, draft)
+

Deletes the software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(cluster, draft)
+

Returns the information about given software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the software draft. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

Drafts.Info

+
+
Returns
+

Information about the Software Draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+import_software_spec(cluster, spec)
+

Imports the desired software specification as a new draft. If a desired +document is missing, then this method will create an empty draft except +when the source type is of either +Drafts.SourceType.LATEST_RECOMMENDATION or +Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION, then +com.vmware.vapi.std.errors_client.NotFound error is reported. +In addition, the exisiting draft will be overwritten when the source +type is of either LATEST_RECOMMENDATION or +CURRENT_SERIES_RECOMMENDATION.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Drafts.ImportSpec) – Specification to import desired software specification.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the software draft. +The return value will be an identifier for the resource type: +com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if the source type of import specification is of either +LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, and +a recommendation does not exist for the cluster. It was either +never generated or deleted due to changes in cluster state such as +a new desired image spec being committed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+list(cluster, filter=None)
+

Returns information about the software drafts for the specified cluster +that match the Drafts.FilterSpec.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • filter (Drafts.FilterSpec or None) – Filter to be applied while returning drafts. +If None, all drafts will be returned.

    • +
+
+
Return type
+

dict of str and Drafts.Summary

+
+
Returns
+

Map of software drafts keyed by their identifiers. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+scan_task(cluster, draft)
+

Scans all the hosts in the cluster against the software draft. The +result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+validate_task(cluster, draft)
+

Validates the software draft. The result of this operation can be +queried by calling the cis/tasks/{task-id} where the task-id is the +response of this operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the software draft. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.EffectiveComponents(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EffectiveComponents class provides methods to get effective list of +components.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+list(cluster)
+

Returns the effective components for the cluster.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

dict of str and com.vmware.esx.settings_client.EffectiveComponentInfo

+
+
Returns
+

Map of effective components keyed by their identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.HardwareSupport(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The HardwareSupport class provides methods to manage a cluster’s +Hardware Support Package (HSP) configuration.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

Returns a given cluster’s Hardware Support Package (HSP) configuration.

+
+
Parameters
+

cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings_client.HardwareSupportInfo

+
+
Returns
+

Hardware Support Package (HSP) selected for use

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster named cluster or no Hardware Support +Package (HSP) configured in the cluster’s desired state document.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.Recommendations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Recommendations class provides methods to manage the generation and +retrieval of recommended image specs.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ExplanationDetails(display_name=None, display_version=None, explanation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Recommendations.ExplanationDetails class contains attributes to +describe the result of validation of desired software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of an excluded image entity (base image, add-on etc.).

    • +

  • display_version (str) – Display version of an excluded image entity (base image, add-on +etc.).

    • +

  • explanation (list of com.vmware.vapi.std_client.LocalizableMessage) – List of explanations on why the image entity is excluded.

    • +
+
+
+
+ +
+
+class FilterSpec(base_image_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Recommendations.FilterSpec class contains attributes used to filter +the generated recommendations (see Recommendations.generate()) based +on a specified base image version. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

base_image_version (str or None) – Base image version string is used in generating the specified base +image recommendations. Default recommendations are generated when +the value is empty. This attribute was added in vSphere API +7.0.2.0.

+
+
+
+ +
+
+class Info(latest_recommendation=None, current_series_recommendation=None, specified_base_image_version_recommendation=None, base_image_explanation_details=None, check_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Recommendations.Info class defines the information about the most +recent recommendation generation result.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • latest_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on latest base image version. +None if no recommended image based on latest base image version is +available.

    • +

  • current_series_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on latest base image patch or +update of the current series. +None if no recommended image based on latest base image patch or +update of the current series is available.

    • +

  • specified_base_image_version_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on a specified base image +version. This attribute was added in vSphere API 7.0.2.0. +None if no recommendation image based on the specified base image +version is available.

    • +

  • base_image_explanation_details (list of Recommendations.ExplanationDetails) – Details about why some base images are excluded in latest and +current series recommendations. This is not applicable for +specified base image recommendations.

    • +

  • check_time (datetime.datetime or None) – The most recent timestamp when check for recommended image is +launched. +None if no recommendation check has ever been launched.

    • +
+
+
+
+ +
+
+generate_task(cluster, filter=None)
+

Generates recommended software image spec(s) based on current desired +software spec. The result of this operation can be queried by calling +the cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • filter (Recommendations.FilterSpec or None) – Specification on how to filter recommendations based on a specified +base image version. This parameter was added in vSphere API +7.0.2.0. +If None, latest and current series recommendations are generated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ConcurrentChange +If a new desired image is committed in parallel via a different +client while recommendation is being generated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
+
+ +
+
+get(cluster)
+

Returns Information about the most recent recommendation generation +result.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Recommendations.Info

+
+
Returns
+

Information about the most recent recommendation generation result.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +recommendation is non-existing for the cluster due to either it is +never generated or deleted due to changes in cluster state such as +a new desired image spec being committed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.Solutions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Solutions class provides methods to manage desired software +solution specifications for an ESX cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.solution'
+

Resource type for solution resource

+
+ +
+
+delete_task(cluster, solution)
+

Deletes the given solution from the desired software specification. The +deletion will be validated along with the entire software specification +before it is committed as new desired spec. The result of this +operation can be queried by calling the cis/tasks/{task-id} where the +task-id is the response of this operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • solution (str) – Identifier of the solution. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if validation of the software document fails. The value of the data +attribute of com.vmware.vapi.std.errors_client.Error will +be a class that contains all the attributes defined in +ValidateResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no solution +associated with solution in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get(cluster, solution)
+

Returns components registered for the given solution in the desired +software specification.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • solution (str) – Identifier of the solution. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.SolutionInfo

+
+
Returns
+

Specification of components registered by the solution.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If invalid component name is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +or no solution associated with solution in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+list(cluster)
+

Returns all solutions in the desired software specification.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

dict of str and com.vmware.esx.settings_client.SolutionInfo

+
+
Returns
+

Map of solutions where key is solution identifier and value is a +list of components registered by that solution. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.solution.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set_task(cluster, solution, spec)
+

Sets the components registered for the given solution in the desired +software specification. The task will set only one solution +specification at a time. Solution constraints would be validated with +the current desired software specification before it is committed as +new desired spec. The result of this operation can be queried by +calling the cis/tasks/{task-id} where the task-id is the response of +this operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • solution (str) – Identifier of the solution. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +

  • spec (com.vmware.esx.settings_client.SolutionSpec) – Registered solution specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if validation of the software document fails. The value of the data +attribute of com.vmware.vapi.std.errors_client.Error will +be a class that contains all the attributes defined in +ValidateResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no solution +associated with solution in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.policies.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.policies.html new file mode 100644 index 00000000..1a7ca84c --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.policies.html @@ -0,0 +1,392 @@ + + + + + + + com.vmware.esx.settings.clusters.policies package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.policies package

+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.policies.apply_client module

+

The com.vmware.esx.settings.clusters.policies.apply_client module provides +classes to manage policies that affect application of desired state +configuration and software for an ESXi cluster. Copyright 2019-2023 VMware, +Inc. All rights reserved. VMware Confidential Copyright 2019-2023 VMware, Inc. +All rights reserved. VMware Confidential

+
+
+class com.vmware.esx.settings.clusters.policies.apply_client.Effective(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Effective class provides methods to manage the effective policies +that will impact how the software and configuration specification documents +are applied to an ESXi cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EffectivePolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None, disable_dpm=None, disable_hac=None, evacuate_offline_vms=None, enforce_hcl_validation=None, parallel_remediation_action=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.EffectivePolicySpec class contains attributes that +describe the effective policies to be used when the software and +configuration specification documents are applied to an ESXi cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Effective.FailureAction) – What action is to be taken if entering maintenance mode fails on a +given host of the cluster.

    • +

  • pre_remediation_power_action (Effective.EffectivePolicySpec.PreRemediationPowerAction) – Specifies what should be done to the power state of the VM before +entering maintenance mode.

    • +

  • enable_quick_boot (bool) – Enable Quick Boot during remediation in the cluster.

    • +

  • disable_dpm (bool) – Disable DPM on the cluster.

    • +

  • disable_hac (bool) – Disable HA Admission control on the cluster.

    • +

  • evacuate_offline_vms (bool) – Evacuate powered off/suspended VMs when attempting maintenance +mode.

    • +

  • enforce_hcl_validation (bool) – Enforce Hcl validation, when applicable, to prevent remediation if +hardware compatibility issues are found. This attribute was added +in vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • parallel_remediation_action (Effective.ParallelRemediationAction) – Enable parallel remediation of hosts in maintenance mode. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.EffectivePolicySpec.PreRemediationPowerAction class +defines the possible actions to be taken, before entering maintenance mode.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on a single host +within the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Effective.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on a single host within the cluster.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.FailureAction.Action class defines the actions to be +taken when entering maintenance mode fails on a single host within the +cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction#retryCount number of times on the failed +host after Apply.FailureAction#retryDelay.

+
+ +
+ +
+ +
+
+class ParallelRemediationAction(enabled=None, max_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Enable parallel remediation for hosts in maintenance mode within a +cluster. This attribute was added in vSphere API 8.0.0.1.

    • +

  • max_hosts (long or None) – Maximum number of hosts that can be remediated in parallel. Setting +com.vmware.esx.settings.clusters.policies_client.Apply.ParallelRemediationAction.max_hosts +does not guarantee maxHosts to be remediated in parallel. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+get(cluster)
+

Returns the effective apply policy based on system defaults and what +has been configured for the cluster.

+
+
Parameters
+

cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Effective.EffectivePolicySpec

+
+
Returns
+

The effective policies that impact the apply method on this +cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.policies.apply_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.drafts.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.drafts.html new file mode 100644 index 00000000..eb886424 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.drafts.html @@ -0,0 +1,1010 @@ + + + + + + + com.vmware.esx.settings.clusters.software.drafts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.software.drafts package

+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.software.drafts.software_client module

+

The com.vmware.esx.settings.clusters.software.drafts.software_client module +provides classes to manage draft of the software documents for ESX cluster.

+
+
+class com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AddOn class provides methods to manage the OEM add-on specification +in a software draft.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'
+

Resource type for add-on resource

+
+ +
+
+delete(cluster, draft)
+

Deletes the desired OEM add-on specification in the software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(cluster, draft)
+

Returns the OEM add-on specification in a software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.AddOnInfo

+
+
Returns
+

OEM add-on specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system or no add-on specification +is set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(cluster, draft, spec)
+

Sets a new desired OEM add-on specification in the software draft. It +will overwrite the existing desired OEM add-on specification if one +already exists.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (com.vmware.esx.settings_client.AddOnSpec) – AddOn specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The BaseImage class provides methods to manage the base-image +specification in a software draft.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'
+

Resource type for base-image resource

+
+ +
+
+get(cluster, draft)
+

Returns the base-image specification in a software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.BaseImageInfo

+
+
Returns
+

Base-image specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(cluster, draft, spec)
+

Sets a new desired base-image specification in the software draft. It +will overwrite the existing desired base-image specification if one +already exists.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (com.vmware.esx.settings_client.BaseImageSpec) – Base-image specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.drafts.software_client.Components(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Components class provides methods to manage component specification +in a software draft.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.component'
+

Resource type for component resource

+
+ +
+
+class UpdateSpec(components_to_set=None, components_to_delete=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Components.UpdateSpec class contains attributes that are specified +to update list of components in the draft.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • components_to_set ((dict of str and (str or None)) or None) – List of components to be updated. If the component already exists +in the draft, the version is updated, else it is added. If a +component is provided without version, then its version will be +chosen based on constraints in the system. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component. +If None, no components will be added or updated.

    • +

  • components_to_delete (set of str or None) – List of components to be removed. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.esx.settings.component. +If None, no components will be removed.

    • +
+
+
+
+ +
+
+delete(cluster, draft, component)
+

Deletes the given component from the software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(cluster, draft, component)
+

Returns the component version for the given component in the software +draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.ComponentInfo or None

+
+
Returns
+

Information about component version. +If None then version will be chosen based on the constraints in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft or no component associated with +component in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+list(cluster, draft)
+

Returns the components that comprise the software draft.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

dict of str and com.vmware.esx.settings_client.ComponentInfo

+
+
Returns
+

Map of component version information keyed by the component +identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(cluster, draft, component, version=None)
+

Set the component version for a given component in the software draft. +This will overwrite any existing version for the given component.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • version (str or None) – Component version. +This attribute is currently required. In the future,if this +attribute is None then version is chosen based on the constraints +in the system.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+update(cluster, draft, spec)
+

Updates the list of components in a given draft. This allows set and/or +delete of multiple components in a batch operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (Components.UpdateSpec) – Update specification containing list of components to add and/or +delete.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EffectiveComponents class provides methods to manage effective list +of components.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+list(cluster, draft)
+

Returns the components that comprise the desired software state of the +cluster.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

dict of str and com.vmware.esx.settings_client.EffectiveComponentInfo

+
+
Returns
+

Map of effective components keyed by their identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no draft +associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The HardwareSupport class provides methods to manage a cluster’s +Hardware Support Package (HSP) configuration in working copy documents.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+delete(cluster, draft)
+

Deletes a given cluster’s working copy document Hardware Support +Package (HSP) configuration.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of image working copy document being updated +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster named cluster, no working copy document +draft in the system, or no Hardware Support Package (HSP) +configured as part of the working copy document.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(cluster, draft)
+

Returns a given cluster’s working copy document Hardware Support +Package (HSP) configuration.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of image working copy document being updated +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.HardwareSupportInfo

+
+
Returns
+

Hardware Support Package (HSP) configured for use

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster named cluster, no working copy document +draft in the system, or no Hardware Support Package (HSP) +configured as part of the working copy document.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(cluster, draft, spec)
+

Replaces a given cluster’s working copy document Hardware Support +Package (HSP) configuration.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • draft (str) – Identifier of image working copy document being updated +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (com.vmware.esx.settings_client.HardwareSupportSpec) – new Hardware Support Package (HSP) configuration for the cluster

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster named cluster, no working copy document +draft in the system, or no Hardware Support Package (HSP) +configured as part of the working copy document.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.drafts.software_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.html new file mode 100644 index 00000000..822755db --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.html @@ -0,0 +1,1801 @@ + + + + + + + com.vmware.esx.settings.clusters.software package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.software package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.software.drafts_client module

+

The com.vmware.esx.settings.clusters.software.drafts_client module provides +classes to manage software drafts for ESX cluster.

+
+
+class com.vmware.esx.settings.clusters.software.drafts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.clusters.software.reports_client module

+

The com.vmware.esx.settings.clusters.software.reports_client module +provides classes to manage reports pertaining to the desired state software for +a cluster of ESXi hosts.

+
+
+class com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ApplyImpact class provides methods to get the impact of an apply +method on a cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyImpactSpec(hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ApplyImpact.ApplyImpactSpec class contains attributes that describe +the specification to be used for getting the impact of an apply method on +an ESXi cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

hosts (set of str or None) – The specific hosts for which an impact is to be generated. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +if None or empty impact is generated for all hosts within the +cluster.

+
+
+
+ +
+
+class ClusterImpact(impact=None, host_impact=None, commit=None, host_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ApplyImpact.ClusterImpact class contains attributes that describe +the summary of how hosts within a cluster will be impacted during an apply +method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (list of ApplyImpact.Impact) – Impact of steps performed during the setup and cleanup phase of the +apply method.

    • +

  • host_impact (dict of str and list of ApplyImpact.Impact) – Impact summary for each host within the clsuter. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • commit (str) – Identifier of the commit on which the impact is generated. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of hosts within the cluster. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +
+
+
+
+ +
+
+class Impact(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ApplyImpact.Impact class contains attributes that describe what the +impact is of a particular step during the apply method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (com.vmware.vapi.std_client.LocalizableMessage) – Description of the impact.

+
+
+
+ +
+
+get(cluster, spec=None)
+

Returns a summary of how hosts within the cluster will be impacted +during an apply method. The impact is generated from the compliance +information obtained from +com.vmware.esx.settings.clusters.software_client.Compliance.get()

+
+
Parameters
+
    +

  • cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (ApplyImpact.ApplyImpactSpec or None) – Specification for how much information should be returned.

    • +
+
+
Return type
+

ApplyImpact.ClusterImpact

+
+
Returns
+

Summary of how hosts will be impacted during an apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.CheckResult(status=None, scan_time=None, updated_since_last_check=None, v_san_data_only=None, commit=None, base_image_version=None, pci_device_compliance=None, storage_device_compliance=None, notifications=None, note=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckResult class contains information to describe HCL compliance +result of a cluster on target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Overall compliance status of Cluster with respective to all hosts +in the cluster.

    • +

  • scan_time (datetime.datetime) – HCL Validation check time.

    • +

  • updated_since_last_check (bool) – Flag to indicate if there were any hardware compatibility overrides +were performed after the last check method. This attribute was +added in vSphere API 7.0.2.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • v_san_data_only (bool or None) – HCL Validation Computed only for vSAN Clusters. +None to show vSAN in UI

    • +

  • commit (str or None) – Spec Identifier of the desired configuration on which the HCL scan +is performed to generate this result, populated by the HCL +validation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +This attribute will be None if validation was performed against a +draft.

    • +

  • base_image_version (str) – Target base image version E.g., version = BaseImageSpec->Version +com.vmware.esx.settings_client.BaseImageSpec.version class

    • +

  • pci_device_compliance (PciDeviceCompliance or None) – Compliance result for the Pci Devices that are present in all hosts +of the cluster. +This attribute will be None if Pci device compliance was not +computed.

    • +

  • storage_device_compliance (StorageDeviceCompliance or None) – Compliance result for storage devices in all the hosts of the +cluster. Currently only includes SAS/SATA storage devices. This +attribute was added in vSphere API 7.0.2.1. +This attribute will be None if storage device compliance was not +computed.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications returned by the HCL Validation operation.

    • +

  • note (com.vmware.vapi.std_client.LocalizableMessage) – Localizable disclaimer notice to show on the UI detailing the type +of checks are done by the HCL Validaiton. Example : HCL Validation +is only done on storage and network controllers.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComplianceStatus class contains the possible different status of +compliance with respect to target version.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceStatus instance.

+
+
+
+
+COMPATIBLE = ComplianceStatus(string='COMPATIBLE')
+

Target hardware is compliant with VMware Compatibility Guide (VCG)

+
+ +
+
+HCL_DATA_UNAVAILABLE = ComplianceStatus(string='HCL_DATA_UNAVAILABLE')
+

HCL data can not be fetched to validate cluster hardware.

+
+ +
+
+INCOMPATIBLE = ComplianceStatus(string='INCOMPATIBLE')
+

Target hardware is not (recognizably) compliant with VMware Compatibility +Guide (VCG)

+
+ +
+
+NO_FIRMWARE_PROVIDER = ComplianceStatus(string='NO_FIRMWARE_PROVIDER')
+

No Firmware HSM present in Software Spec to get Firmware Details +com.vmware.esx.settings_client.HardwareSupportPackageInfo class

+
+ +
+
+UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')
+

Target hardware compliance with VMware Compatibility Guide (VCG) cannot be +determined.

+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComplianceStatusDetail class contains the essential status values +for compliance with respect to target VMware Compatibility Guide (VCG). +This enumeration was added in vSphere API 7.0.2.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceStatusDetail instance.

+
+
+
+
+CERTIFIED = ComplianceStatusDetail(string='CERTIFIED')
+

Hardware is specifically certified for target vSphere version according to +the VCG/HCL. This class attribute was added in vSphere API 7.0.2.1.

+
+ +
+
+FIRMWARE_VERSION_UNKNOWN = ComplianceStatusDetail(string='FIRMWARE_VERSION_UNKNOWN')
+

No firmware version information is available (for example no Hardware +Support Manager, HSM, configured in the cluster’s Software Spec to get +Firmware Details +com.vmware.esx.settings_client.HardwareSupportPackageInfo class or +the system failed to retrieve the current firmware version of a device +using the specified HSM. This class attribute was added in vSphere API +7.0.2.1.

+
+ +
+
+HCL_DATA_UNAVAILABLE = ComplianceStatusDetail(string='HCL_DATA_UNAVAILABLE')
+

HCL data can not be fetched to validate cluster hardware. This class +attribute was added in vSphere API 7.0.2.1.

+
+ +
+
+HOSTS_UNAVAILABLE = ComplianceStatusDetail(string='HOSTS_UNAVAILABLE')
+

Hosts in cluster are not available to validate cluster hardware. This class +attribute was added in vSphere API 7.0.2.1.

+
+ +
+
+MUTED = ComplianceStatusDetail(string='MUTED')
+

When a user requests a non-compliance or HCL compliance unavailable warning +to be suppressed. This class attribute was added in vSphere API 7.0.2.1.

+
+ +
+
+NOT_CERTIFIED = ComplianceStatusDetail(string='NOT_CERTIFIED')
+

Hardware is specifically not certified for target vSphere version according +to the VCG/HCL. This class attribute was added in vSphere API 7.0.2.1.

+
+ +
+
+UNKNOWN = ComplianceStatusDetail(string='UNKNOWN')
+

When given hardware may be certified for a release but its status can’t be +definitively determined due to ambiguity in server model, CPU series, or +BIOS version. This class attribute was added in vSphere API 7.0.2.1.

+
+ +
+
+USER_FLAGGED = ComplianceStatusDetail(string='USER_FLAGGED')
+

When a server or device’s HCL compliance status has been overridden by the +user to mark the system as non-compliant. This class attribute was added in +vSphere API 7.0.2.1.

+
+ +
+
+USER_VERIFIED = ComplianceStatusDetail(string='USER_VERIFIED')
+

When a server or device’s HCL compliance status has been overridden by the +user to mark the system as compliant. This class attribute was added in +vSphere API 7.0.2.1.

+
+ +
+
+VENDOR_UPDATE = ComplianceStatusDetail(string='VENDOR_UPDATE')
+

When BIOS or firmware has been updated from a certified entry found in the +VMware Compatibility Guide (VCG). This class attribute was added in vSphere +API 7.0.2.1.

+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion(driver_version=None, firmware_version=None, driver_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DriverFirmwareVersion class contains information about device’s +driver and firmware version combination from Hardware Compatibility List or +from the target versions from the desired state.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • driver_version (str) – Driver Version.

    • +

  • firmware_version (str) – Firmware Version. This will be an empty string if the target +firmware version cannot be determined.

    • +

  • driver_name (str) – Driver Name.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.FirmwareVersionMatchingCriteria(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The FirmwareVersionMatchingCriteria class contains the criteria for +firmware version comparison. This enumeration was added in vSphere API +8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the FirmwareVersionMatchingCriteria instance.

+
+
+
+
+EXACT = FirmwareVersionMatchingCriteria(string='EXACT')
+
+ +
+
+MINIMUM = FirmwareVersionMatchingCriteria(string='MINIMUM')
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The HardwareCompatibility class provides methods to manage HCL +Validation of a software specification of an ESX cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckSummary(status=None, scan_time=None, commit=None, base_image_version=None, summary_result=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareCompatibility.CheckSummary class contains information to +describe the HCL compliance summary result of a cluster on target software +specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (HardwareCompatibility.ComplianceStatus) – Overall compliance status of the cluster with respective to all +hosts in the cluster.

    • +

  • scan_time (datetime.datetime) – HCL Validation check time.

    • +

  • commit (str or None) – Spec Identifier of the desired configuration on which the HCL scan +is performed to generate this result, populated by the HCL +validation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +This attribute will be None if validation was performed against a +draft.

    • +

  • base_image_version (str) – Target base image version E.g., version = BaseImageSpec->Version +com.vmware.esx.settings_client.BaseImageSpec.version class

    • +

  • summary_result (com.vmware.vapi.std_client.LocalizableMessage) – Over all Compliance result for cluster for the software +specification.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications returned by the HCL Validation operation.

    • +
+
+
+
+ +
+
+class ComplianceStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The HardwareCompatibility.ComplianceStatus class contains the possible +different status of compliance with respect to target version.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceStatus instance.

+
+
+
+
+COMPATIBLE = ComplianceStatus(string='COMPATIBLE')
+

Target hardware is compliant with VCG/HCL. This includes (from the +ComplianceStatusDetail:

+
    +

  • COMPLIANT

    • +

  • VENDOR_UPDATE

    • +

  • USER_OVERRIDE

    • +
+
+ +
+
+HCL_DATA_UNAVAILABLE = ComplianceStatus(string='HCL_DATA_UNAVAILABLE')
+

HCL data can not be fetched to validate cluster hardware.

+
+ +
+
+INCOMPATIBLE = ComplianceStatus(string='INCOMPATIBLE')
+

Target hardware is not (recognizably) compliant with VCG/HCL This includes +(from the ComplianceStatusDetail):

+
    +

  • NONCOMPLIANT

    • +

  • USER_FLAGGED

    • +

  • NONCOMPLIANCE_MUTED

    • +
+
+ +
+
+NO_FIRMWARE_PROVIDER = ComplianceStatus(string='NO_FIRMWARE_PROVIDER')
+

No Firmware HSM present in Software Spec to get Firmware Details +com.vmware.esx.settings_client.HardwareSupportPackageInfo class

+
+ +
+
+UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')
+

Target hardware compliance with VCG/HCL cannot be determined This includes +(from the ComplianceStatusDetail):

+
    +

  • HCL_DATA_UNAVAILABLE

    • +

  • UNAVAILABLE

    • +

  • NO_FIRMWARE_PROVIDER

    • +

  • UNKNOWN

    • +
+
+ +
+ +
+
+check_task(cluster)
+

Initiates a Cluster HCL Validation check for a given cluster. The +result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure and any +possible resolution(s).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+get(cluster)
+

Returns the HCL validation check summary.

+
+
Parameters
+

cluster (str) – identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

HardwareCompatibility.CheckSummary

+
+
Returns
+

CheckSummary HCL validation summary.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure and any +possible resolution(s).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.HardwareCompatibility.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.HardwareCompatibility.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastApplyResult class provides methods to get the most recent +available result of applying the desired software document to all hosts +within a cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyResult(status=None, commit=None, host_info=None, host_status=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastApplyResult.ApplyResult class contains attributes that describe +the result of an apply method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (LastApplyResult.ApplyStatus) – Specifies the aggregated status of the apply method.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired software +document to be applied to all hosts within the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of the hosts in this cluster to which the desired +software document specified by the +LastApplyResult.ApplyResult.commit should be applied to. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • host_status (dict of str and LastApplyResult.ApplyStatus) – Status of the hosts in this cluster to which the desired software +document specified by the +LastApplyResult.ApplyResult.commit was applied to. Hosts on +which the apply method was sucessful are specified by +LastApplyResult.ApplyResult.successful_hosts. Hosts on +which the apply method failed are specified by +LastApplyResult.ApplyResult.failed_hosts. Hosts which were +skipped by the apply method are specified by +LastApplyResult.ApplyResult.skipped_hosts. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • successful_hosts (set of str) – Hosts in this cluster to which the desired software document +specified by the LastApplyResult.ApplyResult.commit has +been successfully applied to. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • failed_hosts (set of str) – Hosts in this cluster to which the desired software document +specified by the LastApplyResult.ApplyResult.commit failed +to be applied to. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • skipped_hosts (set of str) – Hosts in this cluster that were skipped by the apply method. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for +com.vmware.esx.settings.clusters_client.Software.apply() +method. These notifications are mutually exclusive with the +notifications in LastApplyResult.ApplyStatus. This attribute +was added in vSphere API 7.0.2.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class ApplyStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastApplyResult.ApplyStatus class contains attributes that describe +the status of an apply method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LastApplyResult.ApplyStatus.Status class contains the possible +different status codes that can be returned while trying to apply the +desired software specification to hosts within the cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully.

+
+ +
+
+RETRY_PENDING = Status(string='RETRY_PENDING')
+

The method is being scheduled for retry. This class attribute was added in +vSphere API 7.0.2.1.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out.

+
+ +
+ +
+ +
+
+get(cluster)
+

Returns the most recent available result of applying the desired +software document to all hosts within the cluster.

+
+
Parameters
+

cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

LastApplyResult.ApplyResult

+
+
Returns
+

Most recent available result of applying the desired software +document to all hosts within the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if there is no result associated with the cluster cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastCheckResult class provides methods to get the most recent +available result of the checks that have been run on a cluster before the +application of the desired software document to all hosts within the +cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckInfo(check=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.CheckInfo class contains attributes that describe a +particular check.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.CheckResult class contains attributes that describe +aggregated status of all checks performed.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (LastCheckResult.Status) – Aggregated status from all checks performed.

    • +

  • start_time (datetime.datetime) – Time when the operation started.

    • +

  • end_time (datetime.datetime) – Time when the operation completed.

    • +

  • commit (str) – The identifier of the commit on which checks have been run. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information about the hosts in this cluster for which checks have +been requested to be run. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • entity_results (list of LastCheckResult.EntityCheckResult) – List of LastCheckResult.EntityCheckResult for all entities for +which checks have been run.

    • +
+
+
+
+ +
+
+class CheckStatus(check=None, status=None, issues=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.CheckStatus class contains attributes that describe +a check result.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class EntityCheckResult(type=None, cluster=None, host=None, status=None, check_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.EntityCheckResult class contains attributes that +describe aggregated status of all checks performed on a specific entity.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LastCheckResult.EntityCheckResult.EntityType) – The entity type for which these checks are being run.

    • +

  • cluster (str) – If the entity type is CLUSTER then the cluster identifier for which +the checks have been run. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +This attribute is optional and it is only relevant when the value +of type is +LastCheckResult.EntityCheckResult.EntityType.CLUSTER.

    • +

  • host (str) – If the entity type is HOST then the host identifier for which the +checks have been run. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of type is +LastCheckResult.EntityCheckResult.EntityType.HOST.

    • +

  • status (LastCheckResult.Status) – Aggregated status from all checks performed on this entity.

    • +

  • check_statuses (list of LastCheckResult.CheckStatus) – List of LastCheckResult.CheckStatus for all checks performed.

    • +
+
+
+
+
+class EntityType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LastCheckResult.EntityCheckResult.EntityType class contains the +entitites on which checks can be performed.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EntityType instance.

+
+
+
+
+CLUSTER = EntityType(string='CLUSTER')
+

Entity type Cluster

+
+ +
+
+HOST = EntityType(string='HOST')
+

Entity type Host

+
+ +
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LastCheckResult.Status class defines the status result for a +particular check.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The check indicates an error.

+
+ +
+
+OK = Status(string='OK')
+

The check indicates a success.

+
+ +
+
+TIMEOUT = Status(string='TIMEOUT')
+

The check did not return in a timely manner.

+
+ +
+
+WARNING = Status(string='WARNING')
+

The check indicates a warning.

+
+ +
+ +
+
+get(cluster)
+

Returns the most recent available result of checks run on the cluster +before the application of the desired software document to all hosts +within the cluster.

+
+
Parameters
+

cluster (str) – The cluster identifier. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

LastCheckResult.CheckResult

+
+
Returns
+

Most recent result available of the checks run on the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if there is no result associated with the cluster cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.PciDevice(display_name=None, driver_name=None, vendor=None, vid=None, did=None, svid=None, ssid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PciDevice class contains information about a PCI Device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the device.

    • +

  • driver_name (str) – Driver Name of the device.

    • +

  • vendor (str) – Vendor Name of the device.

    • +

  • vid (str) – PCI VID of the device.

    • +

  • did (str) – PCI DID of the device.

    • +

  • svid (str) – PCI SVID of the device.

    • +

  • ssid (str) – PCI SSID of the device.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance(status=None, compatible_devices=None, incompatible_devices=None, incompatible_driver_firmware=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PciDeviceCompliance class contains information that describe the +compliance result of all pci device from all hosts in the clsuter with +respect to the component present in the target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Over all Compliance status of PCI Devices in Cluster with +respective to all hosts in the cluster.

    • +

  • compatible_devices (list of PciDeviceComplianceInfo) – Compatible Device Compliance result for all devices present on all +hosts in the cluster compared with the corresponding component in +the software specification. The key is the DeviceName and value is +the PciDeviceComplianceInfo object.

    • +

  • incompatible_devices (list of PciDeviceComplianceInfo) – Incompatible Device Compliance result for all devices present on +all hosts in the cluster compared with the corresponding component +in the software specification. The key is the DeviceName and value +is the PciDeviceComplianceInfo object.

    • +

  • incompatible_driver_firmware (list of PciDeviceComplianceInfo) – Incompatible Driver Firmware combination Compliance result for all +devices present on hosts in the cluster compared with the +corresponding component in the software specification. The key is +the DeviceName and value is the PciDeviceComplianceInfo object.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo(status=None, device=None, compatible_versions=None, host_info=None, target=None, validated_features_in_use=None, supported=None, constraints=None, compatibility_guide_link=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PciDeviceComplianceInfo class contains information that describe +the compliance of a pci device with respect to the component present in the +target software specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – High-level compliance status of the device.

    • +

  • device (PciDevice) – Pci Device Details

    • +

  • compatible_versions (list of str) – List of vSphere Versions compatible for this device. This field is +populated only for device found INCOMPATIBLE

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Affected List of Host IDs where this device is found. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • target (DriverFirmwareVersion) – Driver and Firmware Version from Image Specification.

    • +

  • validated_features_in_use (dict of Service and set of str) – Validated features in use on this device If Service is set but +features is empty, device is active for solution Subset of +validated features for which we provide certification - for example +RDMA, not IPV6 Inclusion in this set of features is independent of +the certification status of device. In other words it’s possible a +device is configured to use a feature it is not certified. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • supported (list of DriverFirmwareVersion) –

    List of Supported Driver and Firmware Version combination from +Harware Compatibility List.

    +
    +

    Deprecated since version vSphere: API 8.0.0.1

    +
    +

    • +

  • constraints (list of PciDeviceConstraint) – List of Supported Driver and Firmware Version combination and +corresponding supportedFeatures from VMware Compatibility Guide +(VCG) listing for the given vSphere version. This attribute was +added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • compatibility_guide_link (str or None) – Provides link to the VMware Compatibility Guide for further +information on the compatibility. +If None there is no VMware Compatibility link available as this is +device used by VSAN.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Device Specific notifications describing the compliance result. +This attribute will be None if there are no notifications

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.PciDeviceConstraint(firmware_version=None, firmware_version_match=None, driver_name=None, driver_version=None, supported_features=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PciDeviceConstraint class contain information about PCI device’s +hardware compatibility certification including details like driver and/or +firmware versions and the set of validated features supported. This class +was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • firmware_version (str or None) – Certified Firmware Version. This attribute was added in vSphere API +8.0.0.1. +This attribute will be None - If there is no firware version +specified for the device

    • +

  • firmware_version_match (FirmwareVersionMatchingCriteria or None) – Criteria for matching firmware version. This attribute was added in +vSphere API 8.0.0.1. +This attribute will be None when firmware version is not set

    • +

  • driver_name (str or None) – Certified Driver Name. This attribute was added in vSphere API +8.0.0.1. +This attribute will be None If there is no driver certification for +the device

    • +

  • driver_version (str or None) – Certified Driver Version(Exact Matching criteria). This attribute +was added in vSphere API 8.0.0.1. +This attribute will be None If there is no driver certification for +the device.

    • +

  • supported_features (dict of Service and set of str) – Map of solutions and the corresponding features that the device is +certified for in the VMware Compatibility Guide If map is empty, +device is not certified for any specific solutions like vSAN. If +Service is set but features are empty, means device is certified +for solution. If Service is set and features is also set, means +device is certified for specific features. This attribute was added +in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.Service(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service class specifies information about vSphere solutions that +have solution specific VMware compatibility Guide certification. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Service instance.

+
+
+
+
+VSAN = Service(string='VSAN')
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompatibility(status=None, compatible_versions=None, supported_firmware_versions=None, constraints=None, vcg_product=None, model=None, partner=None, compatibility_guide_link=None, used_for_compliance=None, user_selected=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageDeviceCompatibility class contains information that describe +the compliance of a storage device with respect to the component present in +the target software specification. This class was added in vSphere API +7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Compliance status of the storage device, when computed based on +this VMware Compatibility Guide (VCG) listing. This attribute was +added in vSphere API 7.0.2.1.

    • +

  • compatible_versions (list of str or None) – List of vSphere Versions compatible for this storage device. This +attribute was added in vSphere API 7.0.2.1. +This attribute will be None if the storage device is certified for +the target ESXi version.

    • +

  • supported_firmware_versions (list of str or None) –

    List of minimum firmware versions supported from VMware +Compatibility Guide (VCG) listing for the given vSphere version. +This attribute was added in vSphere API 7.0.2.1. +This attribute will be None if the storage device is not certified +for the target ESXi version or the storage device is only certified +in combination with specific driver versions, in which case +listedDriverFirmwareVersions below will be set.

    +
    +

    Deprecated since version vSphere: API 8.0.0.1

    +
    +

    • +

  • constraints (list of StorageDeviceConstraint) – List of Supported Firmware Versions and corresponding supported +features from VMware Compatibility Guide (VCG) listing for the +given vSphere version. This attribute was added in vSphere API +8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • vcg_product (str) – Identifier of the VMware Compatibility Guide (VCG) listing for the +product. This attribute was added in vSphere API 7.0.2.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.vcg_product. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.vcg_product.

    • +

  • model (str) – Model name of the storage device as listed in the VMware +Compatibility Guide (VCG) listing. This may not be the same as the +StorageDeviceInfo.model. This attribute was added in +vSphere API 7.0.2.1.

    • +

  • partner (str) – OEM partner name of the storage device as listed in the VMware +Compatibility Guide (VCG) listing. This attribute was added in +vSphere API 7.0.2.1.

    • +

  • compatibility_guide_link (str) – Provides link to the VMware Compatibility Guide (VCG) listing for +further information on the compatibility. This attribute was added +in vSphere API 7.0.2.1.

    • +

  • used_for_compliance (bool) – Flag to indicate whether this VMware compatibility Guide (VCG) +listing was used to compute the overall compatibility of the +storage device. This attribute was added in vSphere API 7.0.2.1.

    • +

  • user_selected (bool) – Flag to indicate if the user has selected this VMware Compatibility +Guide (VCG) listing to be considered to compute the overall +compatibility of the storage device. This attribute was added in +vSphere API 7.0.2.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – VMware compatibility Guide (VCG) listing specific notifications +describing the compliance result. This attribute was added in +vSphere API 7.0.2.1. +This attribute will be None if there are no notifications

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance(status=None, compatible_devices=None, incompatible_devices=None, unknown_devices=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageDeviceCompliance class contains information that describe +the compliance result of all storage devices from all hosts in the cluster +with respect to the storage device model and the firmware certification. +This class was added in vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ComplianceStatus) – Overall compliance status of storage devices in the cluster with +respect to all hosts in the cluster. This attribute was added in +vSphere API 7.0.2.1.

    • +

  • compatible_devices (list of StorageDeviceComplianceInfo) –

    Lists compliance information for storage devices found to be +compliant with VMware Compatibility Guide (VCG) during the last +check method.

    +

    Note that complianceStatus of every device is not necessarily +COMPATIBLE due to changes made after this check was run; entries +are only rearranged when a new check method is invoked. +lastOverrideTime being greater than the scanTime is an indication +that there were changes made after the last check method. This +attribute was added in vSphere API 7.0.2.1.

    +

    • +

  • incompatible_devices (list of StorageDeviceComplianceInfo) –

    Lists compliance information for storage devices found to be +non-compliant with VMware Compatibility Guide (VCG) during the last +check method.

    +

    Note that complianceStatus of every device is not necessarily +INCOMPATIBLE due to changes made after this check was run; entries +are only rearranged when a new check method is invoked. +lastOverrideTime being greater than the scanTime is an indication +that there were changes made after the last check method. This +attribute was added in vSphere API 7.0.2.1.

    +

    • +

  • unknown_devices (list of StorageDeviceComplianceInfo) –

    Lists storage devices whose compliance information could not be +computed successfully during the last check method.

    +

    Note that complianceStatus of every device is not necessarily +UNAVAILABLE due to changes made after this check was run; entries +are only rearranged when a new check method is invoked. +lastOverrideTime being greater than the scanTime is an indication +that there were changes made after the last check method. This +attribute was added in vSphere API 7.0.2.1.

    +

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Storage device compliance specific notifications describing the +compliance result. This attribute was added in vSphere API 7.0.2.1. +This attribute will be None if there are no notifications

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo(storage_device_info=None, device_count=None, status=None, detail=None, host_info=None, firmware_version=None, validated_features_in_use=None, driver_name=None, driver_version=None, matches=None, used_by_vsan=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageDeviceComplianceInfo class contains attributes that describe +the compliance information of a storage device. This class was added in +vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • storage_device_info (StorageDeviceInfo) – Information of the storage device. This attribute was added in +vSphere API 7.0.2.1.

    • +

  • device_count (long) – Indicate the number of actual physical storage devices represented +by this info. This attribute was added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • status (ComplianceStatus) – Compliance status of the storage device. When there are multiple +possible VMware Compatibility Guide (VCG) matches for the storage +device, the compliance status would be set to +ComplianceStatus.UNAVAILABLE Each match found would be +listed under StorageDeviceComplianceInfo.matches with the +corresponding compliance status of the storage device if compared +against the constraints specified in the match. This attribute was +added in vSphere API 7.0.2.1.

    • +

  • detail (ComplianceStatusDetail) – Detailed compliance status of the storage device. This attribute +was added in vSphere API 7.0.2.1.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Affected List of Host IDs where this device is found. This +attribute was added in vSphere API 7.0.2.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • firmware_version (str or None) – Firmware version on the storage device. This attribute was added in +vSphere API 7.0.2.1. +This attribute will be None if the firmware version on the storage +device is unknown or cannot be determined.

    • +

  • validated_features_in_use (dict of Service and set of str) – Validated Features in use on the storage device If Service is set +but features is empty, device is active for solution Subset of +validated features for which we provide certification - for example +RDMA, not IPV6 Inclusion in this set of features is independent of +the certification status of device. In other words it’s possible a +device is configured to use a feature it is not certified. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • driver_name (str or None) – Driver name on the storage device. This attribute was added in +vSphere API 8.0.0.1. +This attribute will be None if there is no driver associated with +the device.

    • +

  • driver_version (str or None) – Driver Version on the storage device. This attribute was added in +vSphere API 8.0.0.1. +This attribute will be None if there is no driver associated with +the device.

    • +

  • matches (list of StorageDeviceCompatibility) –

    Provides information about possible compatibility matches for the +given storage device.

    +

    There could be multiple possible matches available in the +compatibility data.. This attribute was added in vSphere API +7.0.2.1.

    +

    • +

  • used_by_vsan (bool) –

    Indicates if the storage device is in use by vSAN. When this flag +is set to true, the hardware compatibility is computed against vSAN +HCL constraints. This attribute was added in vSphere API 7.0.2.1.

    +
    +

    Deprecated since version vSphere: API 8.0.0.1

    +
    +

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Device Specific notifications describing the compliance result. +This attribute was added in vSphere API 7.0.2.1. +This attribute will be None if there are no notifications

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceConstraint(firmware_version=None, firmware_version_match=None, driver_name=None, driver_version=None, supported_features=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageHclConstraint class contains information about Storage +device’s hardware compatibility certification including details like driver +and/or firmware versions and the set of validated features supported. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • firmware_version (str or None) – Certified Firmware Version. This attribute was added in vSphere API +8.0.0.1. +This attribute will be None- If there is no firware version +specified for the device

    • +

  • firmware_version_match (FirmwareVersionMatchingCriteria or None) – Criteria for matching firmware version. This attribute was added in +vSphere API 8.0.0.1. +This attribute will be None when firmware version is not set

    • +

  • driver_name (str or None) – Certified Driver Name. This attribute was added in vSphere API +8.0.0.1. +This attribute will be None If there is no driver certification for +the device

    • +

  • driver_version (str or None) – Certified Driver Version. This attribute was added in vSphere API +8.0.0.1. +This attribute will be None If there is no driver certification for +the device

    • +

  • supported_features (dict of Service and set of str) – Map of solutions and the corresponding features that the device is +certified for in the VMware Compatibility Guide If map is empty, +device is not certified for any specific solutions like vSAN If +Service is set but features are empty, means device is certified +for solution. If Service is set and features is also set, means +device is certified for specific features. This attribute was added +in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo(model=None, vendor=None, part_number=None, capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StorageDeviceInfo class contains attributes describing a storage +device. This class was added in vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • model (str) – Storage device model. This attribute was added in vSphere API +7.0.2.1.

    • +

  • vendor (str) – Storage device vendor. This attribute was added in vSphere API +7.0.2.1.

    • +

  • part_number (str or None) – Hardware part number of the storage device. This attribute was +added in vSphere API 7.0.2.1. +This attribute will be unest if part number information is not +available for the storage device.

    • +

  • capacity (long) – Capacity of the storage device in bytes. This attribute was added +in vSphere API 7.0.2.1.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html new file mode 100644 index 00000000..bc319fd0 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html @@ -0,0 +1,542 @@ + + + + + + + com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package

+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client module

+
+
+class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

This class provides methods to manage hardware hardware compatibility +overrides for storage devices. This class was added in vSphere API 7.0.2.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ComplianceAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComplianceStatus.ComplianceAction class enumerates the possible +compliance status overrides for a storage device. This enumeration was +added in vSphere API 7.0.2.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComplianceAction instance.

+
+
+
+
+FLAG_AS_INCOMPATIBLE = ComplianceAction(string='FLAG_AS_INCOMPATIBLE')
+

Specifying this override for a storage device would flag the drive as +non-compliant with VMware Compatibility Guide (VCG). This class attribute +was added in vSphere API 7.0.2.1.

+
+ +
+
+MARK_AS_VERIFIED = ComplianceAction(string='MARK_AS_VERIFIED')
+

Specifying this override for a storage device would ignore the +compatibility issues if any, and treat the drive as compliant with VMware +Compatibility Guide (VCG). This class attribute was added in vSphere API +7.0.2.1.

+
+ +
+
+SUPPRESS_WARNING = ComplianceAction(string='SUPPRESS_WARNING')
+

Specifying this override for a storage device would suppress the +compatibility issues if any. This class attribute was added in vSphere API +7.0.2.1.

+
+ +
+ +
+
+class Key(model=None, vendor=None, capacity=None, part_number=None, firmware_version=None, driver_name=None, driver_version=None, release=None, validated_features_in_use=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComplianceStatus.Key class specifies information about the storage +device for which this override must be applied to. This class was added in +vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • model (str) –

    • +

  • vendor (str) –

    • +

  • capacity (long) –

    • +

  • part_number (str or None) – storage device part number. This attribute was added in vSphere API +7.0.2.1. +If {\@term.unset} the override will be applied to the entries +without a part number.

    • +

  • firmware_version (str or None) – storage device firmware version. This attribute was added in +vSphere API 7.0.2.1. +If {\@term.unset} the override is applied to the entries with an +unknown firmware version.

    • +

  • driver_name (str or None) – Driver name of this storage device if applicable/available. This +attribute was added in vSphere API 8.0.0.1. +This attribute will be None if there is no driver associated with +the device.

    • +

  • driver_version (str or None) – Driver version of this storage device if applicable/available. This +attribute was added in vSphere API 8.0.0.1. +This attribute will be None if there is no driver associated with +the device.

    • +

  • release (str or None) – vSphere release that an override must be applied to. This attribute +was added in vSphere API 7.0.2.1. +If this attribute is unset, +com.vmware.vapi.std.errors_client.InvalidArgument is +thrown. The field is left optional to support wildcard matching in +a future release.

    • +

  • validated_features_in_use ((dict of ComplianceStatus.Service and set of str) or None) – Validated features for which this override applies If a service is +specified but no specific features are included, the device is +taken to be in use by the service. This attribute was added in +vSphere API 8.0.0.1. +If this attribute is None this is taken to mean that the device is +active for the vSAN service (and no specific features). This is +done in order to support 7.0 U3 clients which do not set this +field. Subset of validated features for which we provide +certification - for example RDMA, not IPV6 Note that this list +represents the features in actual current use, which could include +features for which the device is not certified

    • +
+
+
+
+ +
+
+class ReclassificationSpec(key=None, override=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComplianceStatus.ReclassificationSpec class contains information +about the storage device and the corresponding override that must be +applied to the specified device. Note: This data structure is specifically +limited to a ‘Key’/’Value’ pair to model smaller changes to the larger +overall set of overrides applicable to a given storage device. This class +was added in vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (ComplianceStatus.Key) – Information about the storage device for which this override must +be applied to. This attribute was added in vSphere API 7.0.2.1.

    • +

  • override (ComplianceStatus.ComplianceAction or None) – Compliance status override for the stroage device. This attribute +was added in vSphere API 7.0.2.1. +If this attribute is None any existing compliance override for the +specified device will be reset.

    • +
+
+
+
+ +
+
+class Service(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ComplianceStatus.Service class specifies information about vSphere +services that have service specific VMware compatibility Guide +certification. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Service instance.

+
+
+
+
+VSAN = Service(string='VSAN')
+
+ +
+ +
+
+class UpdateSpec(device_reclassifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComplianceStatus.UpdateSpec class describes the updates to be made +to the compatibility overrides for storage devices in a cluster. This class +was added in vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

device_reclassifications (list of ComplianceStatus.ReclassificationSpec) – List of compatibility overrides to be applied for the storage +devices in a cluster. This attribute was added in vSphere API +7.0.2.1.

+
+
+
+ +
+
+update_task(cluster, update_spec)
+

Updates the Compliance staus overrides for storage devices in a +cluster. This method also updates the existing +com.vmware.esx.settings.clusters.software.reports_client.CheckResult +if any, based on the device reclassification specified in +ComplianceStatus.UpdateSpec The storage device categorization +based on the compliance status from the last check result will remain +the same until a +com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check() +method is invoked. This method was added in vSphere API 7.0.2.1.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • update_spec (ComplianceStatus.UpdateSpec) – Specification for updating the compliance status overrides for +storage devices in a cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is an unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no cluster associated with the cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the values in the update specification is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

This class provides methods to manage VMware Compatibility Guide (VCG) +product overrides for storage devices in a cluster. This class was added in +vSphere API 7.0.2.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Key(model=None, vendor=None, capacity=None, part_number=None, firmware_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VcgEntries.Key class specifies information about the storage device +for which this override must be applied to. This class was added in vSphere +API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • model (str) –

    • +

  • vendor (str) –

    • +

  • capacity (long) –

    • +

  • part_number (str or None) – storage device part number. This attribute was added in vSphere API +7.0.2.1. +If {\@term.unset} the override will be applied to the entries +without a part number.

    • +

  • firmware_version (str or None) – storage device firmware version. This attribute was added in +vSphere API 7.0.2.1. +If {\@term.unset} the override is applied to all firmware +versions.

    • +
+
+
+
+ +
+
+class ProductSelectionSpec(key=None, vcg_product=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VcgEntries.ProductSelectionSpec class contains information about +the storage device and the corresponding VMware Compatibility Guide (VCG) +product override that must be applied to the specified device. This class +was added in vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (VcgEntries.Key) – Information about the storage device for which this override must +be applied to. This attribute was added in vSphere API 7.0.2.1.

    • +

  • vcg_product (str or None) – VMware Compatibility Guide (VCG) product selection that must be +applied to the specified storage device. This attribute was added +in vSphere API 7.0.2.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.vcg_product. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.vcg_product. +if {\@term.unset} any existing vcg selection for the storage +device will be removed

    • +
+
+
+
+ +
+
+class UpdateSpec(product_selections=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VcgEntries.UpdateSpec class desribes the updates to be made to the +compatibility overrides for storage devices in a cluster. This class was +added in vSphere API 7.0.2.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

product_selections (list of VcgEntries.ProductSelectionSpec) – List of VMware Compatibility Guide (VCG) overrides to be applied +for the storage devices in a cluster. This attribute was added in +vSphere API 7.0.2.1.

+
+
+
+ +
+
+update_task(cluster, update_spec)
+

Updates the storage device VMware Compatibility Guide (VCG) product +overrides for a cluster. This method also updates the existing +com.vmware.esx.settings.clusters.software.reports_client.CheckResult +if any, based on the additional information provided by the vcg product +overrides for the devices. The storage device categorization based on +the compliance status from the last check result will remain the same +until a +com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check() +method is invoked. This method was added in vSphere API 7.0.2.1.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • update_spec (VcgEntries.UpdateSpec) – Specification for updating the compatibility overrides for the +cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is an unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no cluster associated with the cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the values in the update specification is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.reports.html b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.reports.html new file mode 100644 index 00000000..407164ab --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.clusters.software.reports.html @@ -0,0 +1,230 @@ + + + + + + + com.vmware.esx.settings.clusters.software.reports package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.clusters.software.reports package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module

+

The +com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client +module provides classes to manage reports pertaining to the desired state +software for a cluster of ESXi hosts.

+
+
+class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Details class provides methods to retrieve selected results from a +previously initiated HCL compliance scan.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

Returns the HCL validation check detailed results.

+
+
Parameters
+

cluster (str) – identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters.software.reports_client.CheckResult

+
+
Returns
+

CheckResult HCL validation result.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure and any +possible resolution(s).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.HardwareCompatibility.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.HardwareCompatibility.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.clusters.html b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.clusters.html new file mode 100644 index 00000000..40298a86 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.clusters.html @@ -0,0 +1,427 @@ + + + + + + + com.vmware.esx.settings.defaults.clusters package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.defaults.clusters package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.defaults.clusters.policies_client module

+

Copyright 2019-2023 VMware, Inc. All rights reserved. VMware Confidential

+
+
+class com.vmware.esx.settings.defaults.clusters.policies_client.Apply(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Apply class provides methods to configure the policies that will +impact how the software and configuration specification documents are +applied to ESXi clusters.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfiguredPolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None, disable_dpm=None, disable_hac=None, evacuate_offline_vms=None, enforce_hcl_validation=None, parallel_remediation_action=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.ConfiguredPolicySpec class contains attributes that describe +the policies configured to be used when the software and configuration +specification documents are applied to ESXi clusters.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Apply.FailureAction or None) – What action is to be taken if entering maintenance mode fails on a +given host of the cluster. +If None, configured value would be unset.

    • +

  • pre_remediation_power_action (Apply.ConfiguredPolicySpec.PreRemediationPowerAction or None) – Specifies what should be done to the power state of the VM before +entering maintenance mode. +If None, configured value would be unset.

    • +

  • enable_quick_boot (bool or None) – Enable Quick Boot during remediation in the cluster. +If None, configured value would be unset.

    • +

  • disable_dpm (bool or None) – Disable DPM on the cluster. +If None, configured value would be unset.

    • +

  • disable_hac (bool or None) – Disable HA Admission control on the cluster. +If None, configured value would be unset.

    • +

  • evacuate_offline_vms (bool or None) – Evacuate powered off/suspended VMs when attempting maintenance +mode. +If None, configured value would be unset.

    • +

  • enforce_hcl_validation (bool or None) – Enforce Hcl validation, when applicable, to prevent remediation if +hardware compatibility issues are found. This attribute was added +in vSphere API 7.0.1.0. +If None, hardware compatibility issues will not prevent +remediation.

    • +

  • parallel_remediation_action (Apply.ParallelRemediationAction or None) – Enable parallel remediation of hosts in maintenance mode. Set max +hosts when applicable. This attribute was added in vSphere API +8.0.0.1. +If None, parallel remediation will not happen.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.ConfiguredPolicySpec.PreRemediationPowerAction class defines +the possible actions to be taken on VMs before entering maintenance mode.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on a single host +within the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Apply.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on a single host within the cluster.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.FailureAction.Action class defines the actions to be taken +when entering maintenance mode fails on a single host within the cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction.retry_count number of times on +the failed host after Apply.FailureAction.retry_delay.

+
+ +
+ +
+ +
+
+class ParallelRemediationAction(enabled=None, max_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Enable parallel remediation for hosts in maintenance mode within a +cluster. This attribute was added in vSphere API 8.0.0.1.

    • +

  • max_hosts (long or None) – Maximum number of hosts that can be remediated in parallel Setting +Apply.ParallelRemediationAction.max_hosts does not +guarantee maxHosts to be remediated in parallel. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+get()
+

Returns the configured policy that has been set.

+
+
Return type
+

Apply.ConfiguredPolicySpec

+
+
Returns
+

The configured policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+set(spec)
+

This API will set the configured policy specification.

+
+
Parameters
+

spec (Apply.ConfiguredPolicySpec) – The policy that needs to be configured.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If invalid value is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.defaults.clusters.policies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.clusters.policies.html b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.clusters.policies.html new file mode 100644 index 00000000..678f8153 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.clusters.policies.html @@ -0,0 +1,380 @@ + + + + + + + com.vmware.esx.settings.defaults.clusters.policies package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.defaults.clusters.policies package

+
+

Submodules

+
+
+

com.vmware.esx.settings.defaults.clusters.policies.apply_client module

+

The com.vmware.esx.settings.defaults.clusters.policies.apply_client module +provides classes to manage policies that affect application of desired state +configuration and software for ESXi clusters. Copyright 2019-2023 VMware, Inc. +All rights reserved. VMware Confidential Copyright 2019-2023 VMware, Inc. All +rights reserved. VMware Confidential

+
+
+class com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Effective class provides methods to manage the effective policies +that will impact how the software and configuration specification documents +are applied to ESXi clusters.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EffectivePolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None, disable_dpm=None, disable_hac=None, evacuate_offline_vms=None, enforce_hcl_validation=None, parallel_remediation_action=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.EffectivePolicySpec class contains attributes that +describe the effective policies to be used when the software and +configuration specification documents are applied to ESXi clusters.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Effective.FailureAction) – What action is to be taken if entering maintenance mode fails on a +given host of the cluster.

    • +

  • pre_remediation_power_action (Effective.EffectivePolicySpec.PreRemediationPowerAction) – Specifies what should be done to the power state of the VM before +entering maintenance mode.

    • +

  • enable_quick_boot (bool) – Enable Quick Boot during remediation in the cluster.

    • +

  • disable_dpm (bool) – Disable DPM on the cluster.

    • +

  • disable_hac (bool) – Disable HA Admission control on the cluster.

    • +

  • evacuate_offline_vms (bool) – Evacuate powered off/suspended VMs when attempting maintenance +mode.

    • +

  • enforce_hcl_validation (bool) – Enforce Hcl validation, when applicable, to prevent remediation if +hardware compatibility issues are found. This attribute was added +in vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • parallel_remediation_action (Effective.ParallelRemediationAction) – Enable parallel remediation of hosts in maintenance mode. Set max +hosts when applicable. This attribute was added in vSphere API +8.0.0.1. +If None, parallel remediation will not happen.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.EffectivePolicySpec.PreRemediationPowerAction class +defines the possible actions to be taken, before entering maintenance mode.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on a single host +within the cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Effective.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on a single host within the cluster.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.FailureAction.Action class defines the actions to be +taken when entering maintenance mode fails on a single host within the +cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction#retryCount number of times on the failed +host after Apply.FailureAction#retryDelay.

+
+ +
+ +
+ +
+
+class ParallelRemediationAction(enabled=None, max_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Enable parallel remediation for hosts in maintenance mode within a +cluster. This attribute was added in vSphere API 8.0.0.1.

    • +

  • max_hosts (long or None) – Maximum number of hosts that can be remediated in parallel. Setting +com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ParallelRemediationAction.max_hosts +does not guarantee maxHosts to be remediated in parallel. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+get()
+

Returns the effective apply policy based on system defaults and what +has been configured.

+
+
Return type
+

Effective.EffectivePolicySpec

+
+
Returns
+

The effective policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.defaults.clusters.policies.apply_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.hosts.html b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.hosts.html new file mode 100644 index 00000000..0e309b06 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.hosts.html @@ -0,0 +1,406 @@ + + + + + + + com.vmware.esx.settings.defaults.hosts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.defaults.hosts package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.defaults.hosts.policies_client module

+

The com.vmware.esx.settings.defaults.hosts.policies_client module provides +classes to manage the default policies that affect management of desired state +configuration and software for ESXi hosts. Copyright (c) 2019-2023 VMware, Inc. +All rights reserved. – VMware Confidential

+
+
+class com.vmware.esx.settings.defaults.hosts.policies_client.Apply(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Apply class provides methods to configure the policies that will +impact how the software and configuration specification documents are +applied to ESXi hosts. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfiguredPolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.ConfiguredPolicySpec class contains attributes that describe +the policies configured to be used when the software and configuration +specification documents are applied to ESXi hosts. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Apply.FailureAction or None) – What action is to be taken if entering maintenance mode fails on an +ESXi host. This attribute was added in vSphere API 8.0.0.1. +If None, configured value would be unset.

    • +

  • pre_remediation_power_action (Apply.ConfiguredPolicySpec.PreRemediationPowerAction or None) – Specifies what should be done to the power state of the VM before +entering maintenance mode. This attribute was added in vSphere API +8.0.0.1. +If None, configured value would be unset.

    • +

  • enable_quick_boot (bool or None) – Enable Quick Boot during remediation of the host. This attribute +was added in vSphere API 8.0.0.1. +If None, configured value would be unset.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.ConfiguredPolicySpec.PreRemediationPowerAction class defines +the possible actions to be taken, before entering maintenance mode. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on an ESXi host. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Apply.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on an ESXi host. This attribute was added in vSphere API +8.0.0.1.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. This attribute was +added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.FailureAction.Action class defines the actions to be taken +when entering maintenance mode fails on an ESXi host. This enumeration was +added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction.retry_count number of times on +the failed host after Apply.FailureAction.retry_delay. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+get()
+

Returns the configured policy that has been set. This method was added +in vSphere API 8.0.0.1.

+
+
Return type
+

Apply.ConfiguredPolicySpec

+
+
Returns
+

The configured policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+set(spec)
+

This API will set the configured policy. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

spec (Apply.ConfiguredPolicySpec) – The policy specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If invalid value is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.defaults.hosts.policies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.hosts.policies.html b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.hosts.policies.html new file mode 100644 index 00000000..251e5dd1 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.hosts.policies.html @@ -0,0 +1,356 @@ + + + + + + + com.vmware.esx.settings.defaults.hosts.policies package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.defaults.hosts.policies package

+
+

Submodules

+
+
+

com.vmware.esx.settings.defaults.hosts.policies.apply_client module

+

The com.vmware.esx.settings.defaults.hosts.policies.apply_client module +provides classes to manage the policies that affect application of desired +state configuration and software for ESXi hosts. Copyright (c) 2019-2023 +VMware, Inc. All rights reserved. – VMware Confidential Copyright (c) +2019-2023 VMware, Inc. All rights reserved. – VMware Confidential

+
+
+class com.vmware.esx.settings.defaults.hosts.policies.apply_client.Effective(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Effective class provides methods to manage the effective policies +that will impact how the software and configuration specification documents +are applied to ESXi hosts. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EffectivePolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.EffectivePolicySpec class contains attributes that +describe the effective policies to be used when the software and +configuration specification documents are applied to ESXi hosts. This class +was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Effective.FailureAction) – What action is to be taken if entering maintenance mode fails on an +ESXi host. This attribute was added in vSphere API 8.0.0.1.

    • +

  • pre_remediation_power_action (Effective.EffectivePolicySpec.PreRemediationPowerAction) – Specifies what should be done to the power state of the VM before +entering maintenance mode. This attribute was added in vSphere API +8.0.0.1.

    • +

  • enable_quick_boot (bool) – Enable Quick Boot during remediation of an ESXi host. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.EffectivePolicySpec.PreRemediationPowerAction class +defines the possible actions to be taken, before entering maintenance mode. +This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on an ESXi host. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Effective.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on an ESXi host. This attribute was added in vSphere API +8.0.0.1.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. This attribute was +added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.FailureAction.Action class defines the actions to be +taken when entering maintenance mode fails on an ESXi host. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction#retryCount number of times on the failed +host after Apply.FailureAction#retryDelay. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+get()
+

Returns the effective policy based on system defaults and what has been +configured. This method was added in vSphere API 8.0.0.1.

+
+
Return type
+

Effective.EffectivePolicySpec

+
+
Returns
+

The effective policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.defaults.hosts.policies.apply_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.html b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.html new file mode 100644 index 00000000..2f1185e5 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.defaults.html @@ -0,0 +1,204 @@ + + + + + + + com.vmware.esx.settings.defaults package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings.defaults package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.defaults.clusters_client module

+

The com.vmware.esx.settings.defaults.clusters_client module provides +classes to manage defaults that affect management of desired state +configuration and software for ESXi clusters.

+
+
+class com.vmware.esx.settings.defaults.clusters_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.defaults.hosts_client module

+

The com.vmware.esx.settings.defaults.hosts_client module provides classes +to manage defaults that affect management of desired state configuration and +software for ESXi hosts.

+
+
+class com.vmware.esx.settings.defaults.hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.depot_content.html b/vsphere/8.0.2.0/com.vmware.esx.settings.depot_content.html new file mode 100644 index 00000000..959dde42 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.depot_content.html @@ -0,0 +1,740 @@ + + + + + + + com.vmware.esx.settings.depot_content package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings.depot_content package

+
+

Submodules

+
+
+

com.vmware.esx.settings.depot_content.add_ons_client module

+

The com.vmware.esx.settings.depot_content.add_ons_client module provides +classes to retrieve OEM specific add-on versions from the depot.

+
+
+class com.vmware.esx.settings.depot_content.add_ons_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.depot_content.add_ons_client.Versions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Versions class provides methods to get OEM add-on versions from the +sync’ed and imported depots.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CategoryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Versions.CategoryType class defines possible values of categories +for a OEM add-on.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CategoryType instance.

+
+
+
+
+BUGFIX = CategoryType(string='BUGFIX')
+

Bugfix

+
+ +
+
+ENHANCEMENT = CategoryType(string='ENHANCEMENT')
+

Enhancement

+
+ +
+
+SECURITY = CategoryType(string='SECURITY')
+

Security

+
+ +
+ +
+
+class ComponentInfo(name=None, display_name=None, version=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.ComponentInfo class defines the information regarding a +component present in OEM add-on.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +

  • version (str) – Version of the component.

    • +

  • display_version (str) – Human readable version of the OEM add-on.

    • +
+
+
+
+ +
+
+class Info(display_name=None, vendor=None, display_version=None, summary=None, description=None, category=None, kb=None, release_date=None, components=None, removed_components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Info class defines the information regarding a OEM add-on +version.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the OEM add-on.

    • +

  • vendor (str) – Vendor of the OEM add-on.

    • +

  • display_version (str) – Human readable version of the OEM add-on.

    • +

  • summary (str) – Summary of the OEM add-on.

    • +

  • description (str) – Discription of the OEM add-on.

    • +

  • category (Versions.CategoryType) – Category of the OEM add-on.

    • +

  • kb (str) – Link to kb article related to this the OEM add-on.

    • +

  • release_date (datetime.datetime) – Release date of the OEM add-on.

    • +

  • components (list of Versions.ComponentInfo) – List of components in this OEM add-on.

    • +

  • removed_components (list of Versions.RemovedComponentInfo) – List of components removed by this OEM add-on.

    • +
+
+
+
+ +
+
+class RemovedComponentInfo(name=None, display_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.RemovedComponentInfo class defines the information +regarding a component removed by the OEM add-on.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +
+
+
+
+ +
+
+get(name, version)
+

Returns information about a given OEM add-on version in the depot.

+
+
Parameters
+
    +

  • name (str) – Name of the OEM add-on +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.add_on.

    • +

  • version (str) – Version of the OEM add-on

    • +
+
+
Return type
+

Versions.Info

+
+
Returns
+

Information about the given OEM add-on

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if OEM add-on with given version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+

com.vmware.esx.settings.depot_content.base_images_client module

+

The com.vmware.esx.settings.depot_content.base_images_client module +provides classes to retrieve base_images from the depot.

+
+
+class com.vmware.esx.settings.depot_content.base_images_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.depot_content.base_images_client.Versions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Versions class provides methods to get versions of base images from +the sync’ed and imported depots.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CategoryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Versions.CategoryType class defines possible values of categories +for a base image.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CategoryType instance.

+
+
+
+
+BUGFIX = CategoryType(string='BUGFIX')
+

Bugfix

+
+ +
+
+ENHANCEMENT = CategoryType(string='ENHANCEMENT')
+

Enhancement

+
+ +
+
+SECURITY = CategoryType(string='SECURITY')
+

Security

+
+ +
+ +
+
+class ComponentVersionInfo(name=None, display_name=None, version=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.ComponentVersionInfo class defines the information +regarding a component present in base image.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +

  • version (str) – Version of the component.

    • +

  • display_version (str) – Human readable version of the base image.

    • +
+
+
+
+ +
+
+class Info(display_name=None, version=None, display_version=None, summary=None, description=None, category=None, kb=None, release_date=None, components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Info class defines the information regarding a base image.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the base image.

    • +

  • version (str) – Version of the base image. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.base_image. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.base_image.

    • +

  • display_version (str) – Human readable version of the base image.

    • +

  • summary (str) – Summary of the base image.

    • +

  • description (str) – Discription of the base image.

    • +

  • category (Versions.CategoryType) – Category of the base image.

    • +

  • kb (str) – Link to kb article related to this the base image.

    • +

  • release_date (datetime.datetime) – Release date of the base image.

    • +

  • components (list of Versions.ComponentVersionInfo) – List of components in this base image.

    • +
+
+
+
+ +
+
+get(version)
+

Returns information about a given base image version in the depot.

+
+
Parameters
+

version (str) – Version of the base image

+
+
Return type
+

Versions.Info

+
+
Returns
+

Information about the given base image

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if base image with given version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+

com.vmware.esx.settings.depot_content.components_client module

+

The com.vmware.esx.settings.depot_content.components_client module provides +classes to retrieve component versions from the depot.

+
+
+class com.vmware.esx.settings.depot_content.components_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.depot_content.components_client.Versions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Versions class provides methods to get component versions from the +sync’ed and imported depots.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CategoryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Versions.CategoryType class defines possible values of categories +for a component.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CategoryType instance.

+
+
+
+
+BUGFIX = CategoryType(string='BUGFIX')
+

Bugfix

+
+ +
+
+ENHANCEMENT = CategoryType(string='ENHANCEMENT')
+

Enhancement

+
+ +
+
+GENERAL = CategoryType(string='GENERAL')
+

General

+
+ +
+
+INFO = CategoryType(string='INFO')
+

Info

+
+ +
+
+MISC = CategoryType(string='MISC')
+

Misc

+
+ +
+
+RECALL = CategoryType(string='RECALL')
+

Recall

+
+ +
+
+RECALL_FIX = CategoryType(string='RECALL_FIX')
+

Recall-fix

+
+ +
+
+SECURITY = CategoryType(string='SECURITY')
+

Security

+
+ +
+ +
+
+class Info(display_name=None, vendor=None, display_version=None, summary=None, description=None, category=None, urgency=None, kb=None, contact=None, release_date=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Info class defines the information regarding a component +version.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the component.

    • +

  • vendor (str) – Vendor of the component.

    • +

  • display_version (str) – Human readable version of the component.

    • +

  • summary (str) – Summary of the component version.

    • +

  • description (str) – Discription of the component version.

    • +

  • category (Versions.CategoryType) – Category of the component version.

    • +

  • urgency (Versions.UrgencyType) – Urgency of the component version.

    • +

  • kb (str) – Link to kb article related to this the component version.

    • +

  • contact (str) – Contact email for the component version.

    • +

  • release_date (datetime.datetime) – Release date of the component version.

    • +
+
+
+
+ +
+
+class UrgencyType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Versions.UrgencyType class defines possible values of urgencies for +a component.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UrgencyType instance.

+
+
+
+
+CRITICAL = UrgencyType(string='CRITICAL')
+

Critical

+
+ +
+
+GENERAL = UrgencyType(string='GENERAL')
+

General

+
+ +
+
+IMPORTANT = UrgencyType(string='IMPORTANT')
+

Important

+
+ +
+
+LOW = UrgencyType(string='LOW')
+

Low

+
+ +
+
+MODERATE = UrgencyType(string='MODERATE')
+

Moderate

+
+ +
+ +
+
+get(name, version)
+

Returns information about a given component version in the depot.

+
+
Parameters
+
    +

  • name (str) – Name of the component +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • version (str) – Version of the component

    • +
+
+
Return type
+

Versions.Info

+
+
Returns
+

Information about the given component

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if component with given version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.depots.html b/vsphere/8.0.2.0/com.vmware.esx.settings.depots.html new file mode 100644 index 00000000..0bc32b4e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.depots.html @@ -0,0 +1,435 @@ + + + + + + + com.vmware.esx.settings.depots package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings.depots package

+
+

Submodules

+
+
+

com.vmware.esx.settings.depots.offline_client module

+

The com.vmware.esx.settings.depots.offline_client module provides classes +to manage vLCM offline depots.

+
+
+class com.vmware.esx.settings.depots.offline_client.Content(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Content class provides methods to manage offline software depots +used during ESX lifecycle management. This class was added in vSphere API +7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(metadata_bundles=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Content.Info class contains fields that describe the information of +metadata bundles of an offline depot. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

metadata_bundles (dict of str and list of com.vmware.esx.settings.depots_client.MetadataInfo) – A list of metadata bundles contained in the depot. The key is +vendor of metadata bundle. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.depots.vendor. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.depots.vendor.

+
+
+
+ +
+
+get(depot)
+

Gets the information of content of an imported offline software depot. +This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

depot (str) – Identifier for the depot. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.offline.

+
+
Return type
+

Content.Info

+
+
Returns
+

Information of content of the imported offline software depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot with given identifier depot in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots.offline_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.depots.online_client module

+

The com.vmware.esx.settings.depots.online_client module provides classes to +manage vLCM online depots.

+
+
+class com.vmware.esx.settings.depots.online_client.Content(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Content class provides methods to manage online software depots +used during ESX lifecycle management. This class was added in vSphere API +7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(metadata_bundles=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Content.Info class contains fields that describe the information of +metadata bundles of an online depot. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

metadata_bundles (dict of str and list of com.vmware.esx.settings.depots_client.MetadataInfo) – A list of metadata bundles contained in the depot. The key is +vendor of metadata bundle. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.depots.vendor. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.depots.vendor.

+
+
+
+ +
+
+get(depot)
+

Gets the information of content of an imported online software depot. +This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

depot (str) – Identifier for the depot. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

+
+
Return type
+

Content.Info

+
+
Returns
+

Information of content of the imported online software depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot with given identifier depot in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots.online_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.depots.umds_client module

+

The com.vmware.esx.settings.depots.umds_client module provides classes to +manage vLCM UMDS depot.

+
+
+class com.vmware.esx.settings.depots.umds_client.Content(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Content class provides methods to manage the UMDS depot used during +ESX lifecycle management. This class was added in vSphere API 7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(metadata_bundles=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Content.Info class contains fields that describe the information of +matadata bundles of the UMDS depot. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

metadata_bundles (dict of str and list of com.vmware.esx.settings.depots_client.MetadataInfo) – A list of metadata bundles contained in the depot. The key is +vendor of metadata bundle. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.depots.vendor. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.depots.vendor.

+
+
+
+ +
+
+get()
+

Gets the information of content about the UMDS depot. This method was +added in vSphere API 7.0.3.0.

+
+
Return type
+

Content.Info

+
+
Returns
+

Information of content of the imported UMDS depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no UMDS depot configured in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots.umds_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.hardware_support.html b/vsphere/8.0.2.0/com.vmware.esx.settings.hardware_support.html new file mode 100644 index 00000000..546fcc8f --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.hardware_support.html @@ -0,0 +1,298 @@ + + + + + + + com.vmware.esx.settings.hardware_support package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings.hardware_support package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.hardware_support.managers_client module

+
+
+class com.vmware.esx.settings.hardware_support.managers_client.Packages(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Packages class provides methods to manage a host’s Hardware Support +Package (HSP) configuration.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(base_image_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Packages.FilterSpec class contains attributes used to filter the +results when listing OEM Hardware Support Packages (HSPs), see +Packages.list()).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

base_image_version (str or None) – vSphere release version the Hardware Support Package (HSP) must +support to match the filter. Only Hardware Support Packages (HSPs) +compatible with the vSphere release version specified in +‘baseImageVersion’ will be returned. The ‘baseImageVersion’ +parameter should be a full numeric base image version string (e.g. +“7.1.0-2.3.436234”). Future implementations may support version +specification by prefix (e.g. “7.1” to specify all updates and +builds of 7.1) or other forms of specification (e.g. “>=7.0”). +Hardware Support Pacakges (HSPs) may be advertised as supporting +truncated version strings to indicate the remainder is wildcarded. +Matching is on the specified substring only, so a bundle supporting +“7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234” +as well as “7.1.0-2.1.4133564” and “7.1.0-1.0.355667” but not +“7.1.0-3.0.63445” or any base image version starting with “7.2”. +Note that we require compatible base image versions be specified at +least down to the update version (i.e. “7.0” is insufficiently +constrained) +If None, all packages will be returned, regardless of base image +version.

+
+
+
+ +
+
+class HardwareSupportPackageInfo(pkg=None, version=None, description=None, supported_releases=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Packages.HardwareSupportPackageInfo class contains attributes that +describe a particular 3rd party Hardware Support Package (HSP)

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pkg (str) – Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or +“Latest Hardware Support Package for Frobozz GenX hardware”) +selected +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package.

    • +

  • version (str) – Version of the Hardware Support Package (e.g. “20180128.1” or +“v42”) selected

    • +

  • description (str) – Description of the Hardware Support Package (HSP) (e.g. for use in +help bubble)

    • +

  • supported_releases (set of str) – Supported vSphere releases

    • +
+
+
+
+ +
+
+list(manager, filter=None)
+

Returns the list of available Hardware Support Packages (HSPs) for a +particular host, as specified by its Hardware Support Manager (HSM)

+
+
Parameters
+
    +

  • manager (str) – Identifier for the Hardware Support Manager (HSM). +The parameter must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.manager.

    • +

  • filter (Packages.FilterSpec or None) – Specification of Hardware Support Packages (HSPs) to be returned +If None, the behavior is equivalent to a +Packages.FilterSpec with all attributes None, which means +all HSPs match the filter.

    • +
+
+
Return type
+

list of Packages.HardwareSupportPackageInfo

+
+
Returns
+

List of available Hardware Support Packages (HSPs) for given +manager

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no Hardware Support Manager (HSM) with the specified +name

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated. named manager in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hardware_support.managers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.hardware_support.managers.html b/vsphere/8.0.2.0/com.vmware.esx.settings.hardware_support.managers.html new file mode 100644 index 00000000..a51a04da --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.hardware_support.managers.html @@ -0,0 +1,361 @@ + + + + + + + com.vmware.esx.settings.hardware_support.managers package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.hardware_support.managers package

+
+

Submodules

+
+
+

com.vmware.esx.settings.hardware_support.managers.packages_client module

+
+
+class com.vmware.esx.settings.hardware_support.managers.packages_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.hardware_support.managers.packages_client.Versions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Versions class provides methods to inspect a Hardware Support +Package (HSP)’s detailed information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ComponentInfo(name=None, display_name=None, version=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.ComponentInfo class defines the information regarding a +component present in HSP manifest.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +

  • version (str) – Version of the component.

    • +

  • display_version (str) – Human readable version of the HSP manifest.

    • +
+
+
+
+ +
+
+class FilterSpec(base_image_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.FilterSpec class contains attributes used to filter the +results when retrieving Hardware Support Packages (HSPs) information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

base_image_version (str or None) – vSphere release version for the component information in the +Hardware Support Package (HSP). Only Hardware Support Packages +(HSPs) compatible with the vSphere release version specified in +‘baseImageVersion’ will be returned. The ‘baseImageVersion’ +parameter should be a full numeric base image version string (e.g. +“7.1.0-2.3.436234”). Future implementations may support version +specification by prefix (e.g. “7.1” to specify all updates and +builds of 7.1) or other forms of specification (e.g. “>=7.0”). +Hardware Support Pacakges (HSPs) may be advertised as supporting +truncated version strings to indicate the remainder is wildcarded. +Matching is on the specified substring only, so a bundle supporting +“7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234” +as well as “7.1.0-2.1.4133564” and “7.1.0-2.0.355667” but not +“7.1.0-3.0.63445” or any base image version starting with “7.2”. +Note that we require compatible base image versions be specified at +least down to the update version (i.e. “7.0” is insufficiently +constrained) +If None, all supported releases will be returned but no specific +component information (added or deleted) will be included.

+
+
+
+ +
+
+class PackageInfo(pkg=None, version=None, description=None, supported_releases=None, components=None, removed_components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.PackageInfo class contains attributes that describe a +particular 3rd party Hardware Support Package (HSP)

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pkg (str) – Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or +“Latest Hardware Support Package for Frobozz GenX hardware”) +selected +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package.

    • +

  • version (str) – Version of the Hardware Support Package (e.g. “20180128.1” or +“v42”) selected

    • +

  • description (str) – Description of the Hardware Support Package (HSP) (e.g. for use in +help bubble)

    • +

  • supported_releases (set of str) – Supported vSphere releases

    • +

  • components (list of Versions.ComponentInfo) – List of components in this HSP manifest.

    • +

  • removed_components (list of Versions.RemovedComponentInfo) – List of components removed by this HSP manifest.

    • +
+
+
+
+ +
+
+class RemovedComponentInfo(name=None, display_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.RemovedComponentInfo class defines the information +regarding a component removed by the HSP manifest.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Identifier of the component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +
+
+
+
+ +
+
+get(manager, pkg, version, filter=None)
+

Returns the detailed information for a specific version of an available +Hardware Support Packages (HSPs) as specified by the Hardware Support +Manager (HSM)

+
+
Parameters
+
    +

  • manager (str) – Identifier for the Hardware Support Manager (HSM). +The parameter must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.manager.

    • +

  • pkg (str) – The name of the Hardware Support Package (HSP) +The parameter must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.package.

    • +

  • version (str) – The version of the Hardware Support Package (HSP)

    • +

  • filter (Versions.FilterSpec or None) – Specification of detailed information to be returned +If None, the behavior is equivalent to a +Versions.FilterSpec with all attributes None, which means +all releases supported are returned but no component information +for any particular release is included.

    • +
+
+
Return type
+

Versions.PackageInfo

+
+
Returns
+

detailed information on Hardware Support Packages (HSPs)

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If any of the specified parameters are Invalid (e.g. if the release +version specified in the query parameter is not, in fact, among +those supported by the Hardware Support Package (HSP).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no Hardware Support Manager (HSM) with the specified +name, or no Hardware Support Package (HSP) with the specified name +and version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated. named manager in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required privilege to perform the +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.html b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.html new file mode 100644 index 00000000..0d59ef7e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.html @@ -0,0 +1,2514 @@ + + + + + + + com.vmware.esx.settings.hosts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings.hosts package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.hosts.enablement_client module

+

The com.vmware.esx.settings.hosts.enablement_client module provides classes +to manage standalone host with a single software specification.

+
+
+class com.vmware.esx.settings.hosts.enablement_client.Software(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Software class provides methods to control whether the host is +managed with a single software specification. This class was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckResult class contains information that describes the +results of the checks. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (dict of Software.CheckType and com.vmware.esx.settings_client.Notifications) – Notifications containing check results grouped by +Software.CheckType type. This attribute was added in +vSphere API 8.0.0.1.

+
+
+
+ +
+
+class CheckSpec(checks_to_skip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckSpec class contains information describing what +checks should be performed. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

checks_to_skip (set of Software.CheckType) – Specifies the checks that should be skipped. If the set is +empty, all checks will be performed. This attribute was added in +vSphere API 8.0.0.1.

+
+
+
+ +
+
+class CheckType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.CheckType class contains various checks to identify the +possibility to enable the feature that manages the host with a single +software specification. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CheckType instance.

+
+
+
+
+SOFTWARE = CheckType(string='SOFTWARE')
+

Perform host software check. The purpose of this check is to report +standalone VIBs (VIBs which are not part of any component). This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+SOFTWARE_SPECIFICATION_EXISTENCE = CheckType(string='SOFTWARE_SPECIFICATION_EXISTENCE')
+

Perform host’s software specification existence check. This class attribute +was added in vSphere API 8.0.0.1.

+
+ +
+
+STATELESSNESS = CheckType(string='STATELESSNESS')
+

Perform host statelessness check. This feature does not support stateless +hosts. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+VERSION = CheckType(string='VERSION')
+

Perform host version check. This feature does not support hosts with +version less than XYZ. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+VSAN_WITNESS_ELIGIBILITY = CheckType(string='VSAN_WITNESS_ELIGIBILITY')
+

Perform vSAN witness check to verify if the standalone host acting as a +vSAN witness can be managed with a software image. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+VUM_REMEDIATION = CheckType(string='VUM_REMEDIATION')
+

Perform VUM active remediation check. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+ +
+
+class EnableSpec(skip_software_check=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.EnableSpec class contains information describing checks +that should be skipped during enablement. Currently only +Software.CheckType.SOFTWARE check can be skipped. This class was +added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

skip_software_check (bool) – Skip Software.CheckType.SOFTWARE check during feature +enablement. This attribute was added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+class Info(enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.Info class contains information describing whether the +feature is enabled. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

enabled (bool) – Status of the feature enablement True if feature is enabled, false +otherwise. This attribute was added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+check_task(host, spec=None)
+

Checks the possibility to manage the host with a single software +specification. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Software.CheckSpec or None) – Check specification. +If None, all checks are performed.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the feature is already enabled for the given host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+enable_task(host, spec=None)
+

Enables the feature which manages the host with a single software +specification. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Software.EnableSpec or None) – Enablement specification. +If None, all checks are performed.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If feature enablement failed for the given host. The value of the +data attribute of com.vmware.vapi.std.errors_client.Error +will be a class that contains all the attributes defined in +Software.CheckResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the feature is already enabled for the given host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+get(host)
+

Returns whether the given standalone host is managed with a single +software specification. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Software.Info

+
+
Returns
+

True if feature is enabled, false otherwise.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.enablement_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.hosts.policies_client module

+

The com.vmware.esx.settings.hosts.policies_client module provides classes +to manage the policies that affect management of desired state configuration +and software for an ESXi host. Copyright (c) 2019-2023 VMware, Inc. All rights +reserved. – VMware Confidential

+
+
+class com.vmware.esx.settings.hosts.policies_client.Apply(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Apply class provides methods to configure the policies that will +impact how the software and configuration specification documents are +applied to an ESXi host. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfiguredPolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.ConfiguredPolicySpec class contains attributes that describe +the policies configured to be used when the software and configuration +specification documents are applied to an ESXi host. This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Apply.FailureAction or None) – What action is to be taken if entering maintenance mode fails on an +ESXi host. This attribute was added in vSphere API 8.0.0.1. +If None, configured value would be unset.

    • +

  • pre_remediation_power_action (Apply.ConfiguredPolicySpec.PreRemediationPowerAction or None) – Specifies what should be done to the power state of the VM before +entering maintenance mode. This attribute was added in vSphere API +8.0.0.1. +If None, configured value would be unset.

    • +

  • enable_quick_boot (bool or None) – Enable Quick Boot during remediation of the host. This attribute +was added in vSphere API 8.0.0.1. +If None, configured value would be unset.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.ConfiguredPolicySpec.PreRemediationPowerAction class defines +the possible actions to take, before entering maintenance mode. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Apply.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on an ESXi host. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Apply.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on an ESXi host. This attribute was added in vSphere API +8.0.0.1.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. This attribute was +added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Apply.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Apply.FailureAction.Action class defines the actions to be taken +when entering maintenance mode fails on an ESXi host. This enumeration was +added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction.retry_count number of times on +the failed host after Apply.FailureAction.retry_delay. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+get(host)
+

Returns the configured policy that has been set for the ESXi host. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – The host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Apply.ConfiguredPolicySpec

+
+
Returns
+

The configured policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+set(host, spec)
+

This API will set the configured policy for an ESXi host. This method +was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – The host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Apply.ConfiguredPolicySpec) – The policy specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If invalid value is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.policies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.hosts.software_client module

+

The com.vmware.esx.settings.hosts.software_client module provides classes +to manage desired software on a standalone host.

+
+
+class com.vmware.esx.settings.hosts.software_client.AddOn(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AddOn class provides methods to manage desired OEM add-on +specification for a given standalone host. This class was added in vSphere +API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'
+

Resource type for add-on resource. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+get(host)
+

Returns the desired OEM add-on specification for a given host. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

com.vmware.esx.settings_client.AddOnInfo

+
+
Returns
+

Desired OEM add-on specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +desired OEM add-on specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.BaseImage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The BaseImage class provides methods to manage desired ESX base image. +This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'
+

Resource type for base-image resource. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+get(host)
+

Returns the desired base-image specification set for given host. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

com.vmware.esx.settings_client.BaseImageInfo

+
+
Returns
+

Base-image specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.Commits(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Commits class provides methods to manage committed changes to +desired software document. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyStatusType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Commits.ApplyStatusType class defines possible values regarding the +application of this commit. This enumeration was added in vSphere API +8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplyStatusType instance.

+
+
+
+
+APPLIED = ApplyStatusType(string='APPLIED')
+

Commit has been applied to the host. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+NOT_APPLIED = ApplyStatusType(string='NOT_APPLIED')
+

Commit hasn’t been applied to the host. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+ +
+
+class Info(author=None, commit_time=None, description=None, apply_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Commits.Info class defines the information about software draft. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • author (str) – Author of the commit. This attribute was added in vSphere API +8.0.0.1.

    • +

  • commit_time (datetime.datetime) – Creation time of the commit. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • description (str) – Description accompanying this commit. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • apply_status (Commits.ApplyStatusType) – Apply status of the commit. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.commit'
+

Resource type for commit resource. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+get(host, commit)
+

Returns the information about a specific commit. This method was added +in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • commit (str) – Identifier of the specific commit. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.commit.

    • +
+
+
Return type
+

Commits.Info

+
+
Returns
+

Information about the commit.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +working copy of the software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.Compliance(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Compliance class provides methods to get compliance results for a +standalone host. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(host)
+

Returns the compliance state for the host. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

com.vmware.esx.settings_client.HostCompliance

+
+
Returns
+

Host compliance result.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.Components(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Components class provides methods to manage desired component +specification for a standalone ESX host. This class was added in vSphere +API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.component'
+

Resource type for component resource. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+get(host, component)
+

Returns the component version for the given component in the desired +software specification. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.ComponentInfo or None

+
+
Returns
+

Details about the component version. +If None then version is supposed to be chosen based on the +constraints in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or or no +component associated with component in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+list(host)
+

Returns a list of components in the desired software specification. +This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

dict of str and com.vmware.esx.settings_client.ComponentInfo

+
+
Returns
+

Map of ComponentInfo keyed by the component identifier. If no +version is specified in desired software specification, then it +will be empty. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.Drafts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Drafts class provides methods to manage working copy of software +documents. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CommitSpec(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.CommitSpec class contains attributes that are used to create +a new commit. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (str or None) – Message to include with the commit. This attribute was added in +vSphere API 8.0.0.1. +If None, message is set to empty string.

+
+
+
+ +
+
+class FilterSpec(owners=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.FilterSpec class contains attributes used to filter the +results when listing software drafts. See Drafts.list(). This class +was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

owners (set of str or None) – Owners of the drafts. This attribute was added in vSphere API +8.0.0.1. +If None or empty, drafts from all owners will be returned.

+
+
+
+ +
+
+class ImportSpec(source_type=None, location=None, file_id=None, software_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ImportSpec class defines the information used to import the +desired software specification. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source_type (Drafts.SourceType) – Type of the source to import the desired software specification. +This attribute was added in vSphere API 8.0.0.1.

    • +

  • location (str) – Location of the software specification file to be imported. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of sourceType is Drafts.SourceType.PULL.

    • +

  • file_id (str) – File identifier returned by the file upload endpoint after file is +uploaded. This attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of sourceType is Drafts.SourceType.PUSH.

    • +

  • software_spec (str) – The JSON string representing the desired software specification. +This attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of sourceType is Drafts.SourceType.JSON_STRING.

    • +
+
+
+
+ +
+
+class Info(metadata=None, software=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Info class defines the information about software draft. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Metadata(owner=None, status=None, creation_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Metadata class defines the metadata information about +software draft. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • owner (str) – Owner of the software draft. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • status (Drafts.StatusType) – Status of the software draft. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • creation_time (datetime.datetime) – Creation time of the software draft. This attribute was added in +vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.draft'
+

Resource type for draft resource. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Drafts.SourceType class defines possible values of sources to +import software specification. This enumeration was added in vSphere API +8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+CURRENT_SERIES_RECOMMENDATION = SourceType(string='CURRENT_SERIES_RECOMMENDATION')
+

Content is from recommended image specification based on latest base image +patch or update of the current series. For example, a host’s current +desired base image is 8.0. Recommendation engine will look into any +recommendable image specification with 8.0 series base images available at +depot manager and try to recommend the highest version within 8.0 series if +possible. Let’s say in this example, depot manager has 8.0 patch a and 8.0 +update 1 base images. Recommendation engine would first validate all +possible images based on 8.0 update 1. If it finds a valid one, it will +store the recommended content with that series. This enum value will point +to that stored recommended image content. Recommendations can be generated +using {\@link: +com.vmware.esx.settings.hosts.software.Recommendations#generate}. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+JSON_STRING = SourceType(string='JSON_STRING')
+

The string representing the content of the software specfication. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+LATEST_RECOMMENDATION = SourceType(string='LATEST_RECOMMENDATION')
+

Content is from recommended image specification based on latest base image +version. Recommendations can be generated using {\@link: +com.vmware.esx.settings.hosts.software.Recommendations#generate}. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+PULL = SourceType(string='PULL')
+

Content is pulled from the URL location. The URL scheme of the value in +{\@link #pullLocation) can be http, https or file. This class attribute +was added in vSphere API 8.0.0.1.

+
+ +
+
+PUSH = SourceType(string='PUSH')
+

Content was previously uploaded using the file upload enpoint present on +vCenter appliance. This endpoint is present at +https://VCENTERFQDN:9087/vum-fileupload URL. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class StatusType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Drafts.StatusType class defines possible values of status of a +software draft. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StatusType instance.

+
+
+
+
+INVALID = StatusType(string='INVALID')
+

Software draft is invalid. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+VALID = StatusType(string='VALID')
+

Software draft is valid. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+
+class Summary(metadata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.Summary class defines the summary information about software +draft. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

metadata (Drafts.Metadata) – Metadata about the software draft. This attribute was added in +vSphere API 8.0.0.1.

+
+
+
+ +
+
+class ValidateResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Drafts.ValidateResult class contains attributes to describe result +of validation of desired software specification. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (com.vmware.esx.settings_client.Notifications) – Notifications associated with the validation. This attribute was +added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+commit_task(host, draft, spec)
+

Commits the specified draft as the desired state document. The result +of this operation can be queried by calling the cis/tasks/{task-id} +where the task-id is the response of this operation. It will also +validate the document before committing it. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the draft. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (Drafts.CommitSpec) – The spec to be used to create the commit.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or if there is no +draft associated with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If validation of the software document fails. The value of the data +attribute of com.vmware.vapi.std.errors_client.Error will +be a class that contains all the attributes defined in +Drafts.ValidateResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+create(host)
+

Creates a new software draft from the desired document. It will be +deleted, when the draft is committed successfully. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the working copy of the document. +The return value will be an identifier for the resource type: +com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If there is already a draft created by this user.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+delete(host, draft)
+

Deletes the software draft. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the draft. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(host, draft)
+

Returns the information about given software draft. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

Drafts.Info

+
+
Returns
+

Information about the Software Draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+import_software_spec(host, spec)
+

Imports the desired software specification. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Drafts.ImportSpec) – Specification to import desired software specification.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the working copy of the document. +The return value will be an identifier for the resource type: +com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +the source type of import specification is of either +LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, and +a recommendation does not exist for the host. It was either never +generated or deleted due to changes in host state such as a new +desired image spec being committed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+list(host, filter=None)
+

Returns information about the software drafts for the specified host +that match the Drafts.FilterSpec. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • filter (Drafts.FilterSpec or None) – Filter to be applied while returning drafts. +If None, all drafts will be returned.

    • +
+
+
Return type
+

dict of str and Drafts.Summary

+
+
Returns
+

Map of software drafts keyed by their identifiers. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.draft.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+scan_task(host, draft)
+

Scans the host against the software draft. The result of this operation +can be queried by calling the cis/tasks/{task-id} where the task-id is +the response of this operation. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+validate_task(host, draft)
+

Validates the software draft. The result of this operation can be +queried by calling the cis/tasks/{task-id} where the task-id is the +response of this operation. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy of the document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.EffectiveComponents(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EffectiveComponents class provides methods to get effective list of +components. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+list(host)
+

Returns the effective components for the host. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

dict of str and com.vmware.esx.settings_client.EffectiveComponentInfo

+
+
Returns
+

Map of effective components keyed by their identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.Recommendations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Recommendations class provides methods to manage the generation and +retrieval of recommended image specs. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ExplanationDetails(display_name=None, display_version=None, explanation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Recommendations.ExplanationDetails class contains attributes to +describe the result of validation of desired software specification. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of an excluded image entity (base image, add-on etc.). +This attribute was added in vSphere API 8.0.0.1.

    • +

  • display_version (str) – Display version of an excluded image entity (base image, add-on +etc.). This attribute was added in vSphere API 8.0.0.1.

    • +

  • explanation (list of com.vmware.vapi.std_client.LocalizableMessage) – List of explanations on why the image entity is excluded. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class Info(latest_recommendation=None, current_series_recommendation=None, base_image_explanation_details=None, check_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Recommendations.Info class defines the information about the most +recent recommendation generation result. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • latest_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on latest base image version. +This attribute was added in vSphere API 8.0.0.1. +None if no recommended image based on latest base image version is +available.

    • +

  • current_series_recommendation (com.vmware.esx.settings_client.SoftwareInfo or None) – Recommended image specification based on latest base image patch or +update of the current series. This attribute was added in vSphere +API 8.0.0.1. +None if no recommended image based on latest base image patch or +update of the current series is available.

    • +

  • base_image_explanation_details (list of Recommendations.ExplanationDetails) – Details about why some base images are excluded in latest and +current series recommendations. This is not applicable for +specified base image recommendations. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • check_time (datetime.datetime or None) – The most recent timestamp when check for recommended image is +launched. This attribute was added in vSphere API 8.0.0.1. +None if no recommendation check has ever been launched.

    • +
+
+
+
+ +
+
+generate_task(host)
+

Generates recommended software image spec(s) based on current desired +software spec. The result of this operation can be queried by calling +the cis/tasks/{task-id} where the task-id is the response of this +operation. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ConcurrentChange +If a new desired image is committed in parallel via a different +client while recommendation is being generated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+get(host)
+

Returns Information about the most recent recommendation generation +result. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Recommendations.Info

+
+
Returns
+

Information about the most recent recommendation generation result.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.Solutions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Solutions class provides methods to manage desired software +solution specifications for an ESX host. This class was added in vSphere +API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.solution'
+

Resource type for solution resource. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+delete_task(host, solution)
+

Deletes the given solution from the desired software specification. The +deletion will be validated along with the entire software specification +before it is committed as new desired spec. The result of this +operation can be queried by calling the cis/tasks/{task-id} where the +task-id is the response of this operation. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • solution (str) – Identifier of the solution. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if validation of the software document fails. The value of the data +attribute of com.vmware.vapi.std.errors_client.Error will +be a class that contains all the attributes defined in +ValidateResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or solution associated +with solution in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+get(host, solution)
+

Returns components registered for the given solution in the desired +software specification. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • solution (str) – Identifier of the solution. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.SolutionInfo

+
+
Returns
+

Specification of components registered by the solution.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no solution +associated with . solution in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+list(host)
+

Returns all solutions in the desired software specification. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

dict of str and com.vmware.esx.settings_client.SolutionInfo

+
+
Returns
+

Map of solutions where key is solution identifier and value is a +list of components registered by that solution. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.solution.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set_task(host, solution, spec)
+

Sets the components registered for the given solution in the desired +software specification. The task will set only one solution +specification at a time. Solution constraints would be validated with +the current desired software specification before it is committed as +new desired spec. The result of this operation can be queried by +calling the cis/tasks/{task-id} where the task-id is the response of +this operation. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • solution (str) – Identifier of the solution. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.solution.

    • +

  • spec (com.vmware.esx.settings_client.SolutionSpec) – Registered solution specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or solution associated +with solution in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.policies.html b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.policies.html new file mode 100644 index 00000000..e5ba0eef --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.policies.html @@ -0,0 +1,371 @@ + + + + + + + com.vmware.esx.settings.hosts.policies package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.hosts.policies package

+
+

Submodules

+
+
+

com.vmware.esx.settings.hosts.policies.apply_client module

+

The com.vmware.esx.settings.hosts.policies.apply_client module provides +classes to manage the policies that affect application of desired state +configuration and software for an ESXi host. Copyright (c) 2019-2023 VMware, +Inc. All rights reserved. – VMware Confidential Copyright (c) 2019-2023 +VMware, Inc. All rights reserved. – VMware Confidential

+
+
+class com.vmware.esx.settings.hosts.policies.apply_client.Effective(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Effective class provides methods to manage the effective policies +that will impact how the software and configuration specification documents +are applied to an ESXi host. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EffectivePolicySpec(failure_action=None, pre_remediation_power_action=None, enable_quick_boot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.EffectivePolicySpec class contains attributes that +describe the effective policies to be used when the software and +configuration specification documents are applied to ESXi hosts. This class +was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failure_action (Effective.FailureAction) – What action is to be taken if entering maintenance mode fails on an +ESXi host. This attribute was added in vSphere API 8.0.0.1.

    • +

  • pre_remediation_power_action (Effective.EffectivePolicySpec.PreRemediationPowerAction) – Specifies what should be done to the power state of the VM before +entering maintenance mode. This attribute was added in vSphere API +8.0.0.1.

    • +

  • enable_quick_boot (bool) – Enable Quick Boot during remediation of an ESXi host. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class PreRemediationPowerAction(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.EffectivePolicySpec.PreRemediationPowerAction class +defines the possible actions to take, before entering maintenance mode. +This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PreRemediationPowerAction instance.

+
+
+
+
+DO_NOT_CHANGE_VMS_POWER_STATE = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')
+

Do not change the VM power state. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+POWER_OFF_VMS = PreRemediationPowerAction(string='POWER_OFF_VMS')
+

Power off VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS = PreRemediationPowerAction(string='SUSPEND_VMS')
+

Suspend VMs before entering maintenance mode. This class attribute was +added in vSphere API 8.0.0.1.

+
+ +
+
+SUSPEND_VMS_TO_MEMORY = PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')
+

Suspend VMs to Memory before entering maintenance mode. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class FailureAction(action=None, retry_delay=None, retry_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Effective.FailureAction class contains attributes that describe the +actions to be taken when entering maintenance mode fails on an ESXi host. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • action (Effective.FailureAction.Action) – What action (FAIL, RETRY) is to be taken if entering maintenance +mode fails on an ESXi host. This attribute was added in vSphere API +8.0.0.1.

    • +

  • retry_delay (long) – Time to wait to retry the failed operation in seconds. This +attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +

  • retry_count (long) – Number of times to retry the failed operation. This attribute was +added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of action is Effective.FailureAction.Action.RETRY.

    • +
+
+
+
+
+class Action(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Effective.FailureAction.Action class defines the actions to be +taken when entering maintenance mode fails on an ESXi host. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Action instance.

+
+
+
+
+FAIL = Action(string='FAIL')
+

Fail the apply method. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+RETRY = Action(string='RETRY')
+

Retry the task Apply.FailureAction#retryCount number of times on the failed +host after Apply.FailureAction#retryDelay. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+get(host)
+

Returns the effective policy based on system defaults and what has been +configured for the ESXi host. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+

host (str) – The host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Effective.EffectivePolicySpec

+
+
Returns
+

The effective policies that impact the apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.policies.apply_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.software.drafts.html b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.software.drafts.html new file mode 100644 index 00000000..0c1fbf4d --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.software.drafts.html @@ -0,0 +1,890 @@ + + + + + + + com.vmware.esx.settings.hosts.software.drafts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.hosts.software.drafts package

+
+

Submodules

+
+
+

com.vmware.esx.settings.hosts.software.drafts.software_client module

+

The com.vmware.esx.settings.hosts.software.drafts.software_client module +provides classes to manage specifications in a software draft for an ESX host.

+
+
+class com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AddOn class provides methods to manage the OEM add-on specification +in a software draft. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'
+

Resource type for add-on resource. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+delete(host, draft)
+

Deletes the desired OEM add-on specification in the software draft. +This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(host, draft)
+

Returns the OEM add-on specification in a software draft. This method +was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.AddOnInfo

+
+
Returns
+

OEM add-on specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system or no add-on specification is set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(host, draft, spec)
+

Sets a new desired OEM add-on specification in the software draft. It +will overwrite the existing desired OEM add-on specification if one +already exists. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (com.vmware.esx.settings_client.AddOnSpec) – AddOn specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The BaseImage class provides methods to manage the base-image +specification in a software draft. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'
+

Resource type for base-image resource. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+get(host, draft)
+

Returns the base-image specification in a software draft. This method +was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.BaseImageInfo

+
+
Returns
+

Base-image specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(host, draft, spec)
+

Sets a new desired base-image specification in the software draft. It +will overwrite the existing desired base-image specification if one +already exists. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (com.vmware.esx.settings_client.BaseImageSpec) – Base-image specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.drafts.software_client.Components(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Components class provides methods to manage component specification +in a software draft. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.component'
+

Resource type for component resource. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+class UpdateSpec(components_to_set=None, components_to_delete=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Components.UpdateSpec class contains attributes that are specified +to update list of components in the draft. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • components_to_set ((dict of str and (str or None)) or None) – List of components to be updated. If the component already exists +in the draft, the version is updated, else it is added. If a +component is provided without version, then its version will be +chosen based on constraints in the system. This attribute was added +in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component. +If None, no components will be added or updated.

    • +

  • components_to_delete (set of str or None) – List of components to be removed. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.esx.settings.component. +If None, no components will be removed.

    • +
+
+
+
+ +
+
+delete(host, draft, component)
+

Deletes the given component from the software draft. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft or no component associated with component in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+get(host, draft, component)
+

Returns the component version for the given component in the software +draft. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +
+
+
Return type
+

com.vmware.esx.settings_client.ComponentInfo or None

+
+
Returns
+

Information about component version. +If None then version will be chosen based on the constraints in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft or no component associated with component in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+list(host, draft)
+

Returns the components that comprise the software draft. This method +was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

dict of str and com.vmware.esx.settings_client.ComponentInfo

+
+
Returns
+

Map of component version information keyed by the component +identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+set(host, draft, component, version=None)
+

Set the component version for a given component in the software draft. +This will overwrite any existing version for the given component. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • component (str) – Identifier of the component. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • version (str or None) – Component version. +This attribute is currently required. In the future,if this +attribute is None then version is chosen based on the constraints +in the system.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+
+update(host, draft, spec)
+

Updates the list of components in a given draft. This allows set and/or +delete of multiple components in a batch operation. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +

  • spec (Components.UpdateSpec) – Update specification containing list of components to add and/or +delete.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.drafts.software_client.EffectiveComponents(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EffectiveComponents class provides methods to manage effective list +of components. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+list(host, draft)
+

Returns the components that comprise the desired software state of the +host. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • draft (str) – Identifier of the working copy document. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.draft.

    • +
+
+
Return type
+

dict of str and com.vmware.esx.settings_client.EffectiveComponentInfo

+
+
Returns
+

Map of effective components keyed by their identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host or no draft associated +with draft in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.drafts.software_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.software.html b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.software.html new file mode 100644 index 00000000..197731d7 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.hosts.software.html @@ -0,0 +1,787 @@ + + + + + + + com.vmware.esx.settings.hosts.software package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.esx.settings.hosts.software package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.hosts.software.drafts_client module

+

The com.vmware.esx.settings.hosts.software.drafts_client module provides +classes to manage software drafts for ESX host.

+
+
+class com.vmware.esx.settings.hosts.software.drafts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.hosts.software.reports_client module

+

The com.vmware.esx.settings.hosts.software.reports_client module provides +classes to manage reports pertaining to the desired state software for +standalone ESXi hosts.

+
+
+class com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ApplyImpact class provides methods to get the impact of an apply +method on a standalone ESXi host. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HostImpact(impact=None, commit=None, host_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ApplyImpact.HostImpact class contains attributes that describe the +summary of how the standalone ESXi host will be impacted during an apply +method. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • impact (list of ApplyImpact.Impact) – Impact of steps performed during the apply method. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • commit (str) – Identifier of the commit on which the impact is generated. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information of the host. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+class Impact(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ApplyImpact.Impact class contains attributes that describe what the +impact is of a particular step during the apply method. This class was +added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (com.vmware.vapi.std_client.LocalizableMessage) – Description of the impact. This attribute was added in vSphere API +8.0.0.1.

+
+
+
+ +
+
+get(host)
+

Returns a summary of how a standalone ESXi host will be impacted during +an apply method. The impact is generated from the compliance +information obtained from +com.vmware.esx.settings.hosts.software_client.Compliance.get(). +This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – The host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

ApplyImpact.HostImpact

+
+
Returns
+

Summary of how hosts will be impacted during an apply method

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastApplyResult class provides methods to get the most recent +available result of applying the desired software document to a standalone +ESXi host. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyResult(status=None, commit=None, host_info=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastApplyResult.ApplyResult class contains attributes that describe +the result of an apply method. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (LastApplyResult.ApplyStatus or None) – Specifies the status of the apply method. This attribute was added +in vSphere API 8.0.0.1. +None if the apply method is in progress.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired software +document to be applied to the standalone host. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information of the host to which the desired software document +specified by the LastApplyResult.ApplyResult.commit needs +to be applied to. This attribute was added in vSphere API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for +com.vmware.esx.settings.hosts_client.Software.apply() method. +These notifications are mutually exclusive with the notifications +in LastApplyResult.ApplyStatus. This attribute was added in +vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class ApplyStatus(status=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastApplyResult.ApplyStatus class contains attributes that describe +the status of an apply method. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (LastApplyResult.ApplyStatus.Status) – The status of the method. This attribute was added in vSphere API +8.0.0.1.

    • +

  • start_time (datetime.datetime) – Time when the method started. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • end_time (datetime.datetime) – Time when the method completed. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of +the method. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LastApplyResult.ApplyStatus.Status class contains the possible +different status codes that can be returned while trying to apply the +desired software specification to a standalone host. This enumeration was +added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+ +
+
+get(host)
+

Returns the most recent available result of applying the desired +software document to the standalone ESXi host. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – the host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

LastApplyResult.ApplyResult

+
+
Returns
+

Most recent available result of applying the desired software +document to the standalone ESXi host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no standalone host associated with host in the +system or if there is no result associated with the host host

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LastCheckResult class provides methods to get the most recent +available result of the checks that have been run on the standalone host +before the application of the desired software document to the host. This +class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckInfo(check=None, name=None, description=None, originator=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.CheckInfo class contains attributes that describe a +particular check. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check (str) – The check identifier. This attribute was added in vSphere API +8.0.0.1.

    • +

  • name (com.vmware.vapi.std_client.LocalizableMessage) – The check name. This attribute was added in vSphere API 8.0.0.1.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Human-readable check description. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • originator (str or None) – The service that performed the check. This attribute was added in +vSphere API 8.0.0.1. +Only set if there is an originator available for this +check.

    • +
+
+
+
+ +
+
+class CheckIssue(description=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.CheckResult class contains attributes that describe +aggregated status of all checks performed. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (LastCheckResult.Status) – Aggregated status from all checks performed. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • start_time (datetime.datetime) – Time when the operation started. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • end_time (datetime.datetime) – Time when the operation completed. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • commit (str) – The identifier of the commit on which checks have been run. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information about the host for which checks have been requested to +be run. This attribute was added in vSphere API 8.0.0.1.

    • +

  • entity_result (LastCheckResult.EntityCheckResult) – List of LastCheckResult.EntityCheckResult for all entities for +which checks have been run. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+class CheckStatus(check=None, status=None, check_issues=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.CheckStatus class contains attributes that describe +a check result. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check (LastCheckResult.CheckInfo) – Information about this check. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • status (LastCheckResult.Status) – The status of this check. This attribute was added in vSphere API +8.0.0.1.

    • +

  • check_issues (list of LastCheckResult.CheckIssue or None) – The issues encountered while running this check. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class EntityCheckResult(type=None, host=None, status=None, check_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LastCheckResult.EntityCheckResult class contains attributes that +describe aggregated status of all checks performed on a specific entity. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LastCheckResult.EntityCheckResult.EntityType) – The entity type for which these checks are being run. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • host (str) – If the entity type is HOST then the host identifier for which the +checks have been run. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of type is +LastCheckResult.EntityCheckResult.EntityType.HOST.

    • +

  • status (LastCheckResult.Status) – Aggregated status from all checks performed on this entity. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • check_statuses (list of LastCheckResult.CheckStatus) – List of LastCheckResult.CheckStatus for all checks performed. +This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class EntityType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LastCheckResult.EntityCheckResult.EntityType class contains the +entities on which checks can be performed. This enumeration was added in +vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EntityType instance.

+
+
+
+
+HOST = EntityType(string='HOST')
+

Entity type Host. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LastCheckResult.Status class defines the status result for a +particular check. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The check indicates an error. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+OK = Status(string='OK')
+

The check indicates a success. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+TIMEOUT = Status(string='TIMEOUT')
+

The check did not return in a timely manner. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+WARNING = Status(string='WARNING')
+

The check indicates a warning. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+ +
+
+get(host)
+

Returns the most recent available result of checks run on the +standalone host before the application of the desired software document +to the host. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – The host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

LastCheckResult.CheckResult

+
+
Returns
+

Most recent available result of the checks run on the host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no standalone host associated with host in the +system or if there is no result associated with the host host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareRemediation.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts.software.reports_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.esx.settings.html b/vsphere/8.0.2.0/com.vmware.esx.settings.html new file mode 100644 index 00000000..7d03a73e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.esx.settings.html @@ -0,0 +1,6783 @@ + + + + + + + com.vmware.esx.settings package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.esx.settings package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.esx.settings.clusters_client module

+

The com.vmware.esx.settings.clusters_client module provides classes to +manage desired state configuration and software for a cluster of ESX hosts.

+
+
+class com.vmware.esx.settings.clusters_client.Configuration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Configuration class provides methods to manage desired +configuration of an ESX cluster. This class was added in vSphere API +8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyResult(status=None, commit=None, software_commit=None, host_info=None, host_status=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configuration.ApplyResult class contains attributes that describe +the result of an Configuration.apply() method. This class was added +in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (com.vmware.esx.settings.clusters.configuration_client.HostStatus or None) – Specifies the aggregated status of the Configuration.apply() +method. This attribute was added in vSphere API 8.0.1.0. +None if the Configuration.apply() method is in progress.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired +configuration document to be applied to all hosts within the +cluster. This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • software_commit (str) – The current commit ID for the software associated with the cluster. +This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of the hosts in this cluster to which the desired +configuration document specified by the +Configuration.ApplyResult.commit should be applied to. This +attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • host_status (dict of str and com.vmware.esx.settings.clusters.configuration_client.HostStatus) – Status of the hosts in this cluster to which the desired +configuration specified by the +Configuration.ApplyResult.commit was applied to. Hosts on +which the Configuration.apply() method was successful are +specified by Configuration.ApplyResult.successful_hosts. +Hosts on which the apply method failed are specified by +Configuration.ApplyResult.failed_hosts. Hosts which were +skipped by the Configuration.apply() method are specified by +Configuration.ApplyResult.skipped_hosts. This attribute was +added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • successful_hosts (set of str) – Hosts in this cluster to which the desired configuration specified +by the Configuration.ApplyResult.commit has been +successfully applied to. This attribute was added in vSphere API +8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • failed_hosts (set of str) – Hosts in this cluster to which the desired configuration specified +by the Configuration.ApplyResult.commit failed to be +applied. This attribute was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • skipped_hosts (set of str) – Hosts in this cluster that were skipped by the +Configuration.apply() method. This attribute was added in +vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +
+
+
+
+ +
+
+class ApplySpec(commit=None, hosts=None, apply_policy_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configuration.ApplySpec class contains attributes that describe the +specification to be used for applying the desired configuration to a +cluster. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • commit (str or None) – The minimum commit identifier of the desired configuration to be +used during the Configuration.apply() method. This attribute +was added in vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the apply method will use the latest commit to +fetch the desired configuration.

    • +

  • hosts (set of str or None) – The specific hosts within the cluster to be considered during the +Configuration.apply() method. This attribute was added in +vSphere API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +if None or empty the Configuration.apply() method will +remediate all hosts within the cluster.

    • +

  • apply_policy_spec (com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec or None) – The parameter can be used to override the default remediation +policies for the task. This attribute was added in vSphere API +8.0.1.0. +if None the default cluster remediation policies are used.

    • +
+
+
+
+ +
+
+class ImportSpec(config=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configuration.ImportSpec class contains the desired configuration +for a cluster and an optional short description of this version of the +configuration. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config (str) – The cluster configuration, encoded as JSON. This attribute was +added in vSphere API 8.0.1.0.

    • +

  • description (str or None) – A description of this version of the configuration. This attribute +was added in vSphere API 8.0.1.0.

    • +
+
+
+
+ +
+
+class Info(metadata=None, host_info=None, config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configuration.Info class defines the information about +configuration commit. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • metadata (Configuration.Metadata) – Metadata about the configuration commit. This attribute was added +in vSphere API 8.0.1.0.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – A mapping of BIOS UUIDs for every host in the cluster to +information about that host. The host-specific/host-override +sections of the configuration use BIOS UUIDs to identify hosts, so +this information can be useful to get details about hosts mentioned +there. This attribute was added in vSphere API 8.0.1.0.

    • +

  • config (str) – Configuration specification associated with the commit, encoded as +JSON. This attribute was added in vSphere API 8.0.1.0.

    • +
+
+
+
+ +
+
+class Metadata(id=None, author=None, creation_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Configuration.Metadata class defines the metadata information about +configuration commit. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The identifier of the commit. This attribute was added in vSphere +API 8.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • author (str) – Author of the configuration commit. This attribute was added in +vSphere API 8.0.1.0.

    • +

  • creation_time (datetime.datetime) – Creation time of the configuration commit. This attribute was added +in vSphere API 8.0.1.0.

    • +
+
+
+
+ +
+
+apply_task(cluster, spec)
+

Applies the cluster configuration associated with the cluster on the +hosts associated with the cluster. This method was added in vSphere API +8.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Configuration.ApplySpec) – The Apply specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +If the cluster is already at the specified commit as described in +the apply specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the Configuration.ApplySpec.commit attribute of spec +specifies an invalid commit, or the +Configuration.ApplySpec.hosts attribute of spec +specifies an invalid host or a host that is not part of the +cluster, or the cluster is not managed with a configuration +specification. Also thrown if the specified cluster is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster found in the inventory or no +Configuration.ApplySpec.commit associated with cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the API timed out before completion.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+check_compliance_task(cluster)
+

Check all the hosts in the cluster for compliance with the desired +document. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If an internal error occurred. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If API is called on a cluster that is not managed by desired +configuration management platform.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the API timed out before completion.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+export_config(cluster)
+

This API will export the configuration associated with the cluster. +This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster on which operation should be performed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings.clusters.configuration_client.ExportResult

+
+
Returns
+

This output structure of type +com.vmware.esx.settings.clusters.Configuration#ExportResult +contains the configuration document encoded as JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Export.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.Export.

    • +
+
+
+
+ +
+
+get(cluster, commit=None, doc_structure=None)
+

Get the cluster configuration and related metadata. The configuration +returned by this API only contains the user-visible configuration +properties available for a the cluster. This method was added in +vSphere API 8.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • commit (str or None) – Identifier of the commit to get. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • doc_structure (com.vmware.esx.settings.clusters.configuration_client.DocumentStructure or None) –

    • +
+
+
Return type
+

Configuration.Info

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster or no commit +associated with commit in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.View.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.ClusterConfiguration.View.

    • +
+
+
+
+ +
+
+import_config_task(cluster, spec)
+

This API replaces the existing desired configuration of the cluster +with the configuration provided in the input parameter document. The +API will internally validate the input configuration against the +configuration schema derived from the cluster software specification +associated with the cluster. If the input configuration document passes +validation, then it will be the desired configuration of the cluster. +The result will specify whether the input document was import +successfully. The result will also list the validation errors in case +the import operation failed. This method was added in vSphere API +8.0.1.0.

+
+

Deprecated since version vSphere: API 8.0.2.0 +Use com.vmware.esx.settings.clusters.configuration.Drafts#Create +instead.

+
+
+
Parameters
+
    +

  • cluster (str) – The cluster on which this operation must be performed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Configuration.ImportSpec) – An Configuration.ImportSpec that contains the new desired +configuration for the cluster.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some other unknown internal error. The accompanying +error message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+precheck_task(cluster)
+

This API will perform precheck of the desired cluster configuration on +each of the hosts in the cluster. The API will check against the +desired image schema whether the desired configuration has added any +requirements for the host to be put in maintenance mode or to be +rebooted. The API will also invoke plugins provided by the +configuration owner to detect if the host needs to be put in +maintenance mode or to be rebooted. If any host needs to be put in +maintenance mode or rebooted, prechecks will be performed at the +cluster and host level. The result will specify the validation errors +if the desired configuration is not valid on the host. If valid, the +result will specify host impact of the desired configuration, and list +the configurations that will change on applying the desired +configuration. If host impact is maintenance mode or reboot, precheck +results will also be specified in the result. This method was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

cluster (str) – The cluster on which to perform precheck. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If API is called on a cluster that is not managed by desired +configuration management platform.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the API timed out before completion.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+validate_task(cluster)
+

Check whether the desired cluster configuration is valid. This method +was added in vSphere API 8.0.1.0.

+
+

Deprecated since version vSphere: API 8.0.2.0 +The desired cluster configuration is validated as part of +Configuration.check_compliance() +Configuration.precheck() APIs.

+
+
+
Parameters
+

cluster (str) – Identifier of the cluster +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If an internal error occurred. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If API is called on a cluster that is not managed by desired +configuration management platform.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the API timed out before completion.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters_client.DepotOverrides(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DepotOverrides class provides methods to manage software depots +overriden for a given cluster. In general ESX servers reach out to vCenter +(VUM) to fetch the metadata and payloads required for lifecycle operations. +But in ROBO environments ESX clusters can’t (or because of bandwidth +requirements shouldn’t) reach out to vCenter to fetch payloads and +metadata. This class allows setting cluster level overrides for depots. If +any depots are provided for a cluster, then vCenter level depots are not +used for that cluster’s remediation. These are not synced periodically at +vCenter and are only used by ESXs for lifecycle operations.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Depot(location=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DepotOverrides.Depot class defines the information regarding a +particular depot override for a given cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

location (str) – Location of the depot override. This could be a location of zip +file or location to an index.xml file.

+
+
+
+ +
+
+class Info(depots=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DepotOverrides.Info class defines the information regarding depot +overrides for a given cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

depots (list of DepotOverrides.Depot) – List of the depot overrides.

+
+
+
+ +
+
+add(cluster, depot)
+

Adds a new depot override to the list of currently configured depot +overrides for a given cluster.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • depot (DepotOverrides.Depot) – Information of a depot override.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If an invalid location is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if depot override with given information already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+
+get(cluster)
+

Returns the information about currently configured depot overrides for +a given cluster.

+
+
Parameters
+

cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

DepotOverrides.Info

+
+
Returns
+

Information about currently configured depot overrides for a given +cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+remove(cluster, depot)
+

Removes a depot override from the list of currently configured depot +overrides for a given cluster.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • depot (DepotOverrides.Depot) – Information of the depot override to be removed.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot override with given information or no cluster +associated with identifier {param.name cluster} in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters_client.Software(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Software class provides methods to manage desired software +specification of an ESX cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyResult(status=None, commit=None, host_info=None, host_status=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ApplyResult class contains attributes that describe the +result of an Software.apply() method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.ApplyStatus or None) – Specifies the aggregated status of the Software.apply() +method. +None if the Software.apply() method is in progress.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired software +document to be applied to all hosts within the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of the hosts in this cluster to which the desired +software document specified by the +Software.ApplyResult.commit should be applied to. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • host_status (dict of str and Software.ApplyStatus) – Status of the hosts in this cluster to which the desired software +document specified by the Software.ApplyResult.commit was +applied to. Hosts on which the Software.apply() method was +successful are specified by +Software.ApplyResult.successful_hosts. Hosts on which the +apply method failed are specified by +Software.ApplyResult.failed_hosts. Hosts which were skipped +by the Software.apply() method are specified by +Software.ApplyResult.skipped_hosts. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • successful_hosts (set of str) – Hosts in this cluster to which the desired software document +specified by the Software.ApplyResult.commit has been +successfully applied to. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • failed_hosts (set of str) – Hosts in this cluster to which the desired software document +specified by the Software.ApplyResult.commit failed to be +applied to. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • skipped_hosts (set of str) – Hosts in this cluster that were skipped by the +Software.apply() method. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for +Software.apply() method. These notifications are mutually +exclusive with the notifications in Software.ApplyStatus. This +attribute was added in vSphere API 7.0.2.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class ApplySpec(commit=None, hosts=None, accept_eula=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ApplySpec class contains attributes that describe the +specification to be used for applying the desired software document to a +cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • commit (str or None) – The minimum commit identifier of the desired software document to +be used during the Software.apply() method. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the apply method will use the latest commit to +fetch the desired state document.

    • +

  • hosts (set of str or None) – The specific hosts within the cluster to be considered during the +Software.apply() method. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +if None or empty the Software.apply() method will remediate +all hosts within the cluster.

    • +

  • accept_eula (bool or None) – Accept the VMware End User License Agreement (EULA) before starting +the Software.apply() method. The VMware EULA is available for +download at, https://www.vmware.com/download/eula.html +if None the Software.apply() method could fail due to the +EULA not being accepted.

    • +
+
+
+
+ +
+
+class ApplyStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ApplyStatus class contains attributes that describe the +status of an Software.apply() method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.ApplyStatus.Status class contains the possible different +status codes that can be returned while trying to Software.apply() +the desired software specification to hosts within the cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully.

+
+ +
+
+RETRY_PENDING = Status(string='RETRY_PENDING')
+

The method is being scheduled for retry. This class attribute was added in +vSphere API 7.0.2.1.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The method is in progress. This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out.

+
+ +
+ +
+ +
+
+class CheckInfo(check=None, name=None, description=None, originator=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckInfo class contains attributes that describe a +particular check.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class CheckIssue(description=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of what was the issue containing as much user-relevant +context as possible. The user should be able to understand which +sub-system failed and why. This attribute was added in vSphere API +7.0.2.0.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – Possible resolution for the issue. This should contain actionable +information that the user can use to resolve the issue. This +attribute was added in vSphere API 7.0.2.0. +Can be left None if no meaningful resolution exists.

    • +
+
+
+
+ +
+
+class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_results=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckResult class contains attributes that describe +aggregated status of all checks performed.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.Status) – Aggregated status from all checks performed.

    • +

  • start_time (datetime.datetime) – Time when the operation started.

    • +

  • end_time (datetime.datetime) – Time when the operation completed.

    • +

  • commit (str) – The identifier of the commit on which checks have been run. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information about the hosts in this cluster for which checks have +been requested to be run. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • entity_results (list of Software.EntityCheckResult) – List of Software.EntityCheckResult for all entities for which +checks have been run.

    • +
+
+
+
+ +
+
+class CheckSpec(commit=None, hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckSpec class contains attributes that describe the +specification to be used for running checks on the cluster before the +Software.apply() method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • commit (str or None) – The minimum commit identifier of the desired software document to +be used during the check method. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the check opertion will use the latest commit to +fetch the desired state document.

    • +

  • hosts (set of str or None) – The specific hosts for which checks need to be performed +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +if None or empty checks are run for all hosts within the cluster.

    • +
+
+
+
+ +
+
+class CheckStatus(check=None, status=None, issues=None, check_issues=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckStatus class contains attributes that describe a +check result.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class EntityCheckResult(type=None, cluster=None, host=None, status=None, check_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.EntityCheckResult class contains attributes that describe +aggregated status of all checks performed on a specific entity.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Software.EntityCheckResult.EntityType) – The entity type for which these checks are being run.

    • +

  • cluster (str) – If the entity type is CLUSTER then the cluster identifier for which +the checks have been run. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +This attribute is optional and it is only relevant when the value +of type is +Software.EntityCheckResult.EntityType.CLUSTER.

    • +

  • host (str) – If the entity type is HOST then the host identifier for which the +checks have been run. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of type is Software.EntityCheckResult.EntityType.HOST.

    • +

  • status (Software.Status) – Aggregated status from all checks performed on this entity.

    • +

  • check_statuses (list of Software.CheckStatus) – List of Software.CheckStatus for all checks performed.

    • +
+
+
+
+
+class EntityType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.EntityCheckResult.EntityType class contains the entitites +on which checks can be performed.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EntityType instance.

+
+
+
+
+CLUSTER = EntityType(string='CLUSTER')
+

Entity type Cluster

+
+ +
+
+HOST = EntityType(string='HOST')
+

Entity type Host

+
+ +
+ +
+ +
+
+class ExportSpec(export_software_spec=None, export_iso_image=None, export_offline_bundle=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ExportSpec class contains information describing how a +software specification or image should be exported.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • export_software_spec (bool) – Whether to export software specification document.

    • +

  • export_iso_image (bool) – Whether to export ISO image.

    • +

  • export_offline_bundle (bool) – Whether to export offline bundle.

    • +
+
+
+
+ +
+
+class ExportType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.ExportType class defines the formats in which software +specification document or image can be exported.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ExportType instance.

+
+
+
+
+ISO_IMAGE = ExportType(string='ISO_IMAGE')
+

Export ISO image.

+
+ +
+
+OFFLINE_BUNDLE = ExportType(string='OFFLINE_BUNDLE')
+

Export offline bundle.

+
+ +
+
+SOFTWARE_SPEC = ExportType(string='SOFTWARE_SPEC')
+

Export software specification document.

+
+ +
+ +
+
+class StageResult(status=None, commit=None, host_info=None, host_status=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.StageResult class contains attributes that describe the +result of a Software.stage() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.StageStatus or None) – Specifies the aggregated status of the Software.stage() +method. This attribute was added in vSphere API 8.0.0.1. +None if the Software.stage() method is in progress.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired software +document to be staged to all hosts within the cluster. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of the hosts in this cluster to which the desired +software document specified by the +Software.StageResult.commit should be staged to. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • host_status (dict of str and Software.StageStatus) – Status of the hosts in this cluster to which the desired software +document specified by the Software.StageResult.commit was +staged to. Hosts on which the Software.stage() method was +successful are specified by +Software.StageResult.successful_hosts. Hosts on which the +stage method failed are specified by +Software.StageResult.failed_hosts. Hosts which were skipped +by the Software.stage() method are specified by +Software.StageResult.skipped_hosts. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: HostSystem. When methods return a value of this class as +a return value, the key in the attribute dict will be an +identifier for the resource type: HostSystem.

    • +

  • successful_hosts (set of str) – Hosts in this cluster to which the desired software document +specified by the Software.StageResult.commit has been +successfully staged to. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • failed_hosts (set of str) – Hosts in this cluster to which the desired software document +specified by the Software.StageResult.commit failed to be +staged to. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • skipped_hosts (set of str) – Hosts in this cluster that were skipped by the +Software.stage() method. For example hosts which are +compliant, or are previously staged shall be skipped. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for +Software.stage() method. These notifications are mutually +exclusive with the notifications in Software.StageStatus. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class StageSpec(commit=None, hosts=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.StageSpec class contains attributes that describe the +specification to be used for staging the desired software document to a +cluster. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • commit (str or None) – The minimum commit identifier of the desired software document to +be used during the Software.stage() method. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the stage method will use the latest commit to +fetch the desired state document.

    • +

  • hosts (set of str or None) – The specific hosts within the cluster to be considered during the +Software.stage() method. This attribute was added in vSphere +API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +if None or empty the Software.stage() method will stage all +hosts within the cluster.

    • +
+
+
+
+ +
+
+class StageStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.StageStatus class contains attributes that describe the +status of a Software.stage() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.StageStatus.Status) – The status of the method. This attribute was added in vSphere API +8.0.0.1.

    • +

  • progress (com.vmware.cis.task_client.Progress or None) – Progress of the operation. This attribute was added in vSphere API +8.0.0.1. +None for cluster StageStatus

    • +

  • start_time (datetime.datetime) – Time when the method started. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • end_time (datetime.datetime) – Time when the method completed. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of +the method. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.StageStatus.Status class contains the possible different +status codes that can be returned while trying to Software.stage() +the desired software specification to hosts within the cluster. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+RETRY_PENDING = Status(string='RETRY_PENDING')
+

The method is being scheduled for retry. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The method is in progress. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.Status class defines the status result for a particular +check.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The check indicates an error.

+
+ +
+
+OK = Status(string='OK')
+

The check indicates a success.

+
+ +
+
+RETRY = Status(string='RETRY')
+

The check failed because of an intermittent error, for example a service is +overloaded. The client can choose to retry the health check before +considering the check as failed. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+TIMEOUT = Status(string='TIMEOUT')
+

The check did not return in a timely manner.

+
+ +
+
+WARNING = Status(string='WARNING')
+

The check indicates a warning.

+
+ +
+ +
+
+apply_task(cluster, spec)
+

Applies the desired software document associated with the given cluster +to hosts within the cluster. If commit attribute is set, +it implies the minimum commit that the Software.apply() method +should use, however if subsequent commits have been made to the desired +state document the apply method will use the most recent desired state +document. The result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Software.ApplySpec) – Apply specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +If the cluster is already at specified commit as described in the +apply specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error or if the EULA has not been +accepted. The accompanying error message will give more details +about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the commit attribute of spec specifies an invalid +commit, or the hosts attribute of spec specifies an invalid +host or a host not part of the cluster, or the cluster is not +managed with a single software specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the operation times out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+check_task(cluster, spec)
+

Runs checks on the cluster before applying the desired software +document across all hosts in the cluster. Checks if all hosts in the +cluster are in a good state to be updated with the desired software +document. If commit attribute is set it implies the +minimum commit that the check method should use, however if subsequent +commits have been made to the desired state document the check method +will use the most recent desired state document. The result of this +operation can be queried by calling the cis/tasks/{task-id} where the +task-id is the response of this operation.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Software.CheckSpec) – Check specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the commit attribute of spec specifies an invalid +commit, or the hosts attribute of spec specifies an invalid +host or a host not part of the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress or if the commit +attribute of spec specifies a commit that has already been +applied.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the operation times out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+export(cluster, spec)
+

Exports the desired software specification document and/or image. This +API will not export the solution section of the desired software +specification.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Software.ExportSpec) –

    • +
+
+
Return type
+

dict of Software.ExportType and str

+
+
Returns
+

A map from export type to URL of the exported data for that type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is am unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+get(cluster)
+

Returns the complete desired software specification.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

com.vmware.esx.settings_client.SoftwareInfo

+
+
Returns
+

Cluster software specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+scan_task(cluster)
+

Scans all the hosts in the cluster against the cluster’s desired state. +The result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+
+stage_task(cluster, spec)
+

Stages the desired software document associated with the given cluster +to hosts within the cluster. If commit attribute is set, +it implies the minimum commit that the Software.stage() method +should use, however if subsequent commits have been made to the desired +state document the stage method will use the most recent desired state +document. The result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Software.StageSpec) – stage specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the commit attribute of spec specifies an invalid +commit, or the hosts attribute of spec specifies an invalid +host or a host not part of the cluster, or the cluster is not +managed with a single software specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no cluster associated with cluster in the system or +if desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the operation times out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.clusters_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.defaults_client module

+

The com.vmware.esx.settings.defaults_client module provides classes to +manage defaults that affect management of desired state configuration and +software for ESXi clusters and hosts.

+
+
+class com.vmware.esx.settings.defaults_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.depot_content_client module

+

The com.vmware.esx.settings.depot_content_client module provides classes to +retrieve contents from the depot.

+
+
+class com.vmware.esx.settings.depot_content_client.AddOns(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AddOns class provides methods to get OEM add-ons from the sync’ed +and imported depots.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class AddOnVersionSummary(version=None, display_version=None, summary=None, category=None, kb=None, release_date=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOns.AddOnVersionSummary class defines the summary information +regarding a version of an OEM add-on.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the OEM add-on.

    • +

  • display_version (str) – Human readable version of the OEM add-on.

    • +

  • summary (str) – Summary of the OEM add-on version.

    • +

  • category (AddOns.CategoryType) – Category of the OEM add-on version.

    • +

  • kb (str) – Link to kb article related to this the OEM add-on version.

    • +

  • release_date (datetime.datetime) – Release date of the OEM add-on version.

    • +
+
+
+
+ +
+
+class CategoryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The AddOns.CategoryType class defines possible values of categories for +a OEM add-on.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CategoryType instance.

+
+
+
+
+BUGFIX = CategoryType(string='BUGFIX')
+

Bugfix

+
+ +
+
+ENHANCEMENT = CategoryType(string='ENHANCEMENT')
+

Enhancement

+
+ +
+
+SECURITY = CategoryType(string='SECURITY')
+

Security

+
+ +
+ +
+
+class FilterSpec(vendors=None, names=None, versions=None, min_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOns.FilterSpec class contains attributes used to filter the +results when listing OEM add-ons, see AddOns.list()).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vendors (set of str or None) – Vendors that an add-on must have to match the filter. +If None or empty, add-ons from any vendor will match the filter.

    • +

  • names (set of str or None) – Names that an add-on must have to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.add_on. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.esx.settings.add_on. +If None or empty, add-ons with any name will match the filter.

    • +

  • versions (set of str or None) – Versions that an add-on must have to match the filter. +If None or empty, add-ons with any version will match the filter.

    • +

  • min_version (str or None) – Minimum version of an add-on that can match the filter. +If set, only OEM add-ons with version greater than or +equal to this will be returned.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'
+

Resource type for add-on resource

+
+ +
+
+class Summary(name=None, display_name=None, vendor=None, versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddOns.Summary class defines the summary information regarding a +OEM add-on.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the OEM add-on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.add_on. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.add_on.

    • +

  • display_name (str) – Display name of the OEM add-on.

    • +

  • vendor (str) – Vendor of the OEM add-on.

    • +

  • versions (list of AddOns.AddOnVersionSummary) – Summary information about the versions of this addon. These are +sorted by the version.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns a list of currently available OEM add-ons in the depot.

+
+
Parameters
+

filter (AddOns.FilterSpec or None) – The specification of matching OEM add-ons. +If None, the behavior is equivalent to a AddOns.FilterSpec +with all attributes None, which means all OEM add-ons match the +filter.

+
+
Return type
+

list of AddOns.Summary

+
+
Returns
+

List of OEM add-ons in the depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depot_content_client.BaseImages(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The BaseImages class provides methods to get base images from the +sync’ed and imported depots.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CategoryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The BaseImages.CategoryType class defines possible values of categories +for a base image.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CategoryType instance.

+
+
+
+
+BUGFIX = CategoryType(string='BUGFIX')
+

Bugfix

+
+ +
+
+ENHANCEMENT = CategoryType(string='ENHANCEMENT')
+

Enhancement

+
+ +
+
+SECURITY = CategoryType(string='SECURITY')
+

Security

+
+ +
+ +
+
+class FilterSpec(min_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImages.FilterSpec class contains attributes used to filter the +results when listing base images, see BaseImages.list()).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

min_version (str or None) – Minimum version of a base image that can match the filter. +If set, only base images with version greater than or +equal to this version will be returned.

+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'
+

Resource type for add-on resource

+
+ +
+
+class Summary(display_name=None, version=None, display_version=None, summary=None, category=None, kb=None, release_date=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImages.Summary class defines the summary information regarding +a base image.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Display name of the base image.

    • +

  • version (str) – Version of the base image. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.base_image. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.base_image.

    • +

  • display_version (str) – Human readable version of the base image.

    • +

  • summary (str) – Summary of the base image.

    • +

  • category (BaseImages.CategoryType) – Category of the base image.

    • +

  • kb (str) – Link to kb article related to this the base image.

    • +

  • release_date (datetime.datetime) – Release date of the base image.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns a list of currently available base images in the depot.

+
+
Parameters
+

filter (BaseImages.FilterSpec or None) – The specification of matching base images. +If None, the behavior is equivalent to a +BaseImages.FilterSpec with all attributes None, which +means all base images match the filter.

+
+
Return type
+

list of BaseImages.Summary

+
+
Returns
+

List of base images in the depot. These will be sorted by the +version of the base image.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depot_content_client.Components(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Components class provides methods to get Components from the +sync’ed and imported depots.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CategoryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Components.CategoryType class defines possible values of categories +for a component.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CategoryType instance.

+
+
+
+
+BUGFIX = CategoryType(string='BUGFIX')
+

Bugfix

+
+ +
+
+ENHANCEMENT = CategoryType(string='ENHANCEMENT')
+

Enhancement

+
+ +
+
+GENERAL = CategoryType(string='GENERAL')
+

General

+
+ +
+
+INFO = CategoryType(string='INFO')
+

Info

+
+ +
+
+MISC = CategoryType(string='MISC')
+

Misc

+
+ +
+
+RECALL = CategoryType(string='RECALL')
+

Recall

+
+ +
+
+RECALL_FIX = CategoryType(string='RECALL_FIX')
+

Recall-fix

+
+ +
+
+SECURITY = CategoryType(string='SECURITY')
+

Security

+
+ +
+ +
+
+class ComponentBundleType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Components.ComponentBundleType class defines possible ways +components are bundled.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ComponentBundleType instance.

+
+
+
+
+ADD_ON = ComponentBundleType(string='ADD_ON')
+

Components bundled in add-ons

+
+ +
+
+BASE_IMAGE = ComponentBundleType(string='BASE_IMAGE')
+

Components bundled in base-images

+
+ +
+
+INDEPENDENT = ComponentBundleType(string='INDEPENDENT')
+

Components not bundled in base-images or add-ons

+
+ +
+ +
+
+class ComponentVersionSummary(version=None, display_version=None, summary=None, category=None, urgency=None, kb=None, release_date=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Components.ComponentVersionSummary class defines the summary +information regarding a version of a component.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the component.

    • +

  • display_version (str) – Human readable version of the component.

    • +

  • summary (str) – Summary of the component version.

    • +

  • category (Components.CategoryType) – Category of the component version.

    • +

  • urgency (Components.UrgencyType) – Urgency of the component version.

    • +

  • kb (str) – Link to kb article related to this the component version.

    • +

  • release_date (datetime.datetime) – Release date of the component version.

    • +
+
+
+
+ +
+
+class FilterSpec(vendors=None, names=None, versions=None, min_version=None, bundle_types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Components.FilterSpec class contains attributes used to filter the +results when listing components, see Components.list()).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vendors (set of str or None) – Vendors that a component must have to match the filter. +If None or empty, components with any vendor name match the filter.

    • +

  • names (set of str or None) – Names that a component must have to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.esx.settings.component. +If None or empty, components with any name will match the filter.

    • +

  • versions (set of str or None) – Versions that a component must have to match the filter. +If None or empty, components with any version will match the +filter.

    • +

  • min_version (str or None) – Minimum version of the component that can match the filter. +If set, only components with version greater than or equal +to the given version match the filter.

    • +

  • bundle_types (set of Components.ComponentBundleType or None) – Component bundle types that a component must have to match the +filter. +If None or empty, all components will match the filter.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.component'
+

Resource type for add-on resource

+
+ +
+
+class Summary(name=None, display_name=None, vendor=None, versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Components.Summary class defines the summary information regarding +a component.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the Component. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.component. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.component.

    • +

  • display_name (str) – Display name of the component.

    • +

  • vendor (str) – Vendor of the component.

    • +

  • versions (list of Components.ComponentVersionSummary) – Summary information about the versions of this component. These are +sorted by the version.

    • +
+
+
+
+ +
+
+class UrgencyType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Components.UrgencyType class defines possible values of urgencies +for a component.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UrgencyType instance.

+
+
+
+
+CRITICAL = UrgencyType(string='CRITICAL')
+

Critical

+
+ +
+
+GENERAL = UrgencyType(string='GENERAL')
+

General

+
+ +
+
+IMPORTANT = UrgencyType(string='IMPORTANT')
+

Important

+
+ +
+
+LOW = UrgencyType(string='LOW')
+

Low

+
+ +
+
+MODERATE = UrgencyType(string='MODERATE')
+

Moderate

+
+ +
+ +
+
+list(filter=None)
+

Returns a list of currently available components in the depot.

+
+
Parameters
+

filter (Components.FilterSpec or None) – The specification of matching components. +If None, the behavior is equivalent to a +Components.FilterSpec with all attributes None, which +means ALL components match the filter.

+
+
Return type
+

list of Components.Summary

+
+
Returns
+

List of components in the depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depot_content_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.depots_client module

+

The com.vmware.esx.settings.depots_client module provides classes to manage +VUM compatible ESX Depots.

+
+
+class com.vmware.esx.settings.depots_client.AddonSummary(display_name=None, vendor=None, versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddonSummary class contains fields that describe the summary of an +addon. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Human readable name of the addon. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • vendor (str) – Vendor of the addon. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.depots.vendor. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.depots.vendor.

    • +

  • versions (list of AddonVersion) – Different versions of the addon. This attribute was added in +vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.AddonVersion(version=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AddonVersion class contains fields that describe a specific version +of an addon. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the addon. This attribute was added in vSphere API +7.0.3.0.

    • +

  • display_version (str) – Human readable version of the addon. This attribute was added in +vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.AffectedBaselineInfo(baseline=None, id=None, affected_updates=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AffectedBaselineInfo class contains the fields that describe which +updates (bulletins) in the baseline will be affected by the depot to be +deleted or disabled. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • baseline (str) – Name of the baseline affected. This attribute was added in vSphere +API 7.0.3.0.

    • +

  • id (long) – Identifier of the baseline affected. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • affected_updates (dict of str and UpdateSummary) – Updates (bulletins) affected. They key is identifier of the update +(bulletin). The value is summary of the update (bulletin). This +attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.depots.bulletin. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.depots.bulletin.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.AffectedDesiredStateInfo(cluster_name=None, cluster_id=None, affected_base_image=None, affected_addon=None, affected_solutions=None, affected_hardware_support=None, affected_independent_components=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AffectedDesiredStateInfo class contains the fields that describe +which release units in the desired state will be affected by the depot to +be deleted or disabled. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster_name (str) – Since now we have standalone host, we use entityName/entityId to +better describe name/id of either cluster or standalone host. Name +of the cluster the affected desired state belongs to. This +attribute was added in vSphere API 7.0.3.0.

    • +

  • cluster_id (str) – Identified of the cluster the affected desired state belongs to. +This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • affected_base_image (BaseImageVersion or None) – Affected base image of the desired state. This attribute was added +in vSphere API 7.0.3.0. +If None, no base image of the desired state will be affected.

    • +

  • affected_addon ((dict of str and AddonSummary) or None) – Affected addon of the desired state. The key is name of addon. +Note: there is at most one addon affected. This attribute was added +in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.add_on. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.add_on. +If None, no addon of the desired state will be affected.

    • +

  • affected_solutions ((dict of str and SolutionSummary) or None) – Affected solutions of the desired state. The key is name of +solution. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.solution. +If None, no solution of the desired state will be affected.

    • +

  • affected_hardware_support ((dict of str and HardwareSupportManagerSummary) or None) – Affected hardware support of the desired state. The key is HSM +name. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. +If None, no hadrware support of the desired state will be affected.

    • +

  • affected_independent_components ((dict of str and ComponentSummary) or None) – Affected independent components of the desired state. The +components belongs to other base images, addons, solutions and +hardware support packages are not counted. The key is name of +component. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component. +If None, no independent components of the desired state will be +affected.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.BaseImageVersion(version=None, display_name=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImageVersion class contains fields that describe a specific +ESXi base image. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the base image. This attribute was added in vSphere API +7.0.3.0.

    • +

  • display_name (str) – Human readable name of the base image. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • display_version (str) – Human readable version of the base image. This attribute was added +in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.ComponentSummary(display_name=None, versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentSummary class contains fields that describe the summary of +a component. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Human readable name of the component. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • versions (list of ComponentVersion) – Different versions of the component. This attribute was added in +vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.ComponentVersion(version=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentVersion class contains fields that describe a specific +version of a component. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the component. This attribute was added in vSphere API +7.0.3.0.

    • +

  • display_version (str) – Human readable version of the component. This attribute was added +in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.HardwareSupportManagerSummary(display_name=None, packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportManagerSummary class contains fields that describe +the summary of a hardware support manager (HSM). This class was added in +vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – UI label for HSM, derived from HSM extension’s description’s +‘label’ field. This attribute was added in vSphere API 7.0.3.0.

    • +

  • packages (dict of str and HardwareSupportPackageSummary) – Different hardware support packages (HSP) published by the HSM. The +key is name of HSP. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.package. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.package.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.HardwareSupportPackageSummary(versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageSummary class contains fields that describe +the summary of a hardware support package (HSP). This class was added in +vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

versions (list of HardwareSupportPackageVersion) – Different versions of the HSP. This attribute was added in vSphere +API 7.0.3.0.

+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.HardwareSupportPackageVersion(version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HardwareSupportPackageVersion class contains fields that describe a +specific version of a hardware support package (HSP). This class was added +in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

version (str) – Version of the HSP. This attribute was added in vSphere API +7.0.3.0.

+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.MetadataInfo(file_name=None, base_images=None, addons=None, solutions=None, hardware_support=None, independent_components=None, updates=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The MetadataInfo class contains fields that show the content of a +metadata bundle. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • file_name (str) – File name of the metadata bundle. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • base_images (list of BaseImageVersion or None) – All the base images contained in the metadata bundle. This +attribute was added in vSphere API 7.0.3.0. +If None, the metadata bundle contains no base image.

    • +

  • addons ((dict of str and AddonSummary) or None) – All the addons contained in the metadata bundle. The key is name of +addon. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.add_on. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.add_on. +If None, the metadata bundle contains no addon.

    • +

  • solutions ((dict of str and SolutionSummary) or None) – All the solutions contained in the metadata bundle. The key is name +of solution. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.solution. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.solution. +If None, the metadata bundle contains no solution.

    • +

  • hardware_support ((dict of str and HardwareSupportManagerSummary) or None) – All the HSMs and their HSPs contained in the metadata bundle. The +key is name of HSM. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. When +methods return a value of this class as a return value, the key in +the attribute dict will be an identifier for the resource +type: com.vmware.esx.setting.hardware_support.manager. +If None, the metadata bundle contains no hardware support manager.

    • +

  • independent_components ((dict of str and ComponentSummary) or None) – All the independent components contained in the metadata bundle. +The components belongs to other base images, addons, solutions and +hardware support packages are not counted. The ksy is name of +component. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.component. When methods return a +value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.esx.settings.component. +If None, the metadata bundle contains no inpendent component.

    • +

  • updates ((dict of str and UpdateSummary) or None) – All the updates (bulletins) contained in the metadata bundle. They +key is identifier of the update (bulletin). The value is summary of +the update (bulletin). This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.esx.settings.depots.bulletin. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.esx.settings.depots.bulletin. +If None, the metadata bundle contains no update (bulletin).

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.Offline(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Offline class provides methods to manage offline software depots +used during ESX lifecycle management.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConnectionSpec(auth_type=None, host_credential=None, host=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.ConnectionSpec class contains attributes that describe the +specification to be used for connecting to the host during the +Offline.create_from_host() method. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auth_type (Offline.ConnectionSpec.AuthenticationType) – Specifies what type of authentication (USERNAME_PASSWORD, EXISTING) +is to be used when connecting with the host. USERNAME_PASSWORD is +intended to be used when connecting to a host that is not currently +part of the vCenter inventory. EXISTING is intented for hosts that +are in vCenter inventory, in which case, HostServiceTicket will be +used to connect to the host. This attribute was added in vSphere +API 7.0.2.0.

    • +

  • host_credential (Offline.HostCredentials) – Specifies the host details to be used during the +Offline.create_from_host() method. This attribute was added +in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of authType is +Offline.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD.

    • +

  • host (str) – Specifies the host Managed Object ID to be used during the +Offline.create_from_host() method. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of authType is +Offline.ConnectionSpec.AuthenticationType.EXISTING.

    • +
+
+
+
+
+class AuthenticationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Offline.ConnectionSpec.AuthenticationType class defines the +possible types of authentication supported when connecting to the host. +This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the AuthenticationType instance.

+
+
+
+
+EXISTING = AuthenticationType(string='EXISTING')
+

Connect to the host using service ticket. Note: This is supported only for +hosts present in the VC inventory. This class attribute was added in +vSphere API 7.0.2.0.

+
+ +
+
+USERNAME_PASSWORD = AuthenticationType(string='USERNAME_PASSWORD')
+

Connect to host using host’s credentials class. This class attribute was +added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class CreateResult(depot=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.CreateResult class defines the result information for a new +offline depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

depot (str) – Identifier of the offline depot. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.depots.offline. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.esx.settings.depots.offline.

+
+
+
+ +
+
+class CreateSpec(description=None, source_type=None, location=None, file_id=None, ownerdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.CreateSpec class defines the information used to create a +depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str or None) – Description of the depot. +If None, the description will be empty.

    • +

  • source_type (Offline.SourceType) – Type of the source from which offline bundle is obtained.

    • +

  • location (str) – Location of the depot from which content should be retrieved. +This attribute is optional and it is only relevant when the value +of sourceType is Offline.SourceType.PULL.

    • +

  • file_id (str) – File identifier returned by the file upload endpoint after file is +uploaded. +This attribute is optional and it is only relevant when the value +of sourceType is Offline.SourceType.PUSH.

    • +

  • ownerdata (str or None) – Private data saved by the Offline.Info.owner of the depot. +It is opaque to vLCM. This attribute was added in vSphere API +7.0.3.0. +If None, no ownerdata will be saved.

    • +
+
+
+
+ +
+
+class DeleteResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.DeleteResult class contains a field that lists all the +errors encountered after starting the task of Offline.delete() +method. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications returned by Offline.delete() method. This +attribute was added in vSphere API 7.0.3.0. +If None, no notification is returned.

+
+
+
+ +
+
+class DepotExtractInfo(notifications=None, software_spec=None, result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.DepotExtractInfo class contains attributes that describe +the extracted depot. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications returned by the extractDepot operation. This +attribute was added in vSphere API 7.0.2.0.

    • +

  • software_spec (com.vmware.esx.settings_client.SoftwareSpec) – Software specification of the extracted depot. This attribute was +added in vSphere API 7.0.2.0.

    • +

  • result (Offline.CreateResult) – The information about the created offline depot. Empty +\@name{result} \@term{string} indicates that the depot +contents are already present in VC cache. This attribute was added +in vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class HostCredentials(host_name=None, user_name=None, password=None, port=None, ssl_thumb_print=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.HostCredentials class contains attributes that describe the +host’s username, password, port number, ssl thumbprint or ssl certificate +to be used when connecting to the host using USERNAME_PASSWORD option in +the class. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host_name (str) – The IP address or DNS resolvable name of the host. This attribute +was added in vSphere API 7.0.2.0.

    • +

  • user_name (str) – Specifies the username to be used during the +Offline.create_from_host() method. This attribute was added +in vSphere API 7.0.2.0.

    • +

  • password (str) – Specifies the password to be used during the +Offline.create_from_host() method. This attribute was added +in vSphere API 7.0.2.0.

    • +

  • port (long or None) – Specifies the port number of the host to be used during +Offline.create_from_host() method. This attribute was added +in vSphere API 7.0.2.0. +If None, port number is set to 443.

    • +

  • ssl_thumb_print (str or None) – Specifies the sslThumbPrint of the host to be used during +Offline.create_from_host() method SHA1 hash of the host’s SSL +certificate. This attribute was added in vSphere API 7.0.2.0. +If None, Offline.create_from_host() method this operation +will throw UnverifiedPeer with the host provided thumbprint as +data.

    • +
+
+
+
+ +
+
+class Info(description=None, source_type=None, location=None, file_id=None, create_time=None, owner=None, ownerdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.Info class defines the information regarding an offline +depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the depot. If not set during import, it will be +empty.

    • +

  • source_type (Offline.SourceType) – Type of the source from which offline depot is obtained.

    • +

  • location (str) – Location of the depot from which content is retrieved. +This attribute is optional and it is only relevant when the value +of sourceType is Offline.SourceType.PULL.

    • +

  • file_id (str) – File identifier returned by the file upload endpoint after file is +uploaded. +This attribute is optional and it is only relevant when the value +of sourceType is Offline.SourceType.PUSH.

    • +

  • create_time (datetime.datetime) – Time when the depot was created.

    • +

  • owner (str or None) – Name of the user creating the depot. This attribute was added in +vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • ownerdata (str or None) – Private data saved by the owner of depot. It is opaque to vLCM. +This attribute was added in vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class PrecheckResult(affected_baselines=None, affected_desired_states=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.PrecheckResult class contains the fields that show the +details of affected baselines and desired states found in +Offline.delete() method. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • affected_baselines (list of AffectedBaselineInfo or None) – Baselines affected. This attribute was added in vSphere API +7.0.3.0. +If None, no baseline is affected.

    • +

  • affected_desired_states (list of AffectedDesiredStateInfo or None) – Desired states affected. This attribute was added in vSphere API +7.0.3.0. +If None, no desired state is affected.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.depots.offline'
+

Resource type for depots resource

+
+ +
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Offline.SourceType class defines possible values of sources for the +offline depot.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+PULL = SourceType(string='PULL')
+

Content is pulled from the URL location. The URL scheme of the value in +{\@link CreateSpec#location) can be http, https or file.

+
+ +
+
+PUSH = SourceType(string='PUSH')
+

Content was previously uploaded using the file upload enpoint present on +vCenter appliance. This endpoint is present at +https://VCENTERFQDN:9087/vum-fileupload URL.

+
+ +
+ +
+
+class Summary(description=None, source_type=None, location=None, file_id=None, owner=None, ownerdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Offline.Summary class defines the summary information regarding an +offline depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the depot. If not set during import, it will be +empty.

    • +

  • source_type (Offline.SourceType) – Type of the source from which offline depot is obtained.

    • +

  • location (str) – Location of the depot from which content is retrieved. +This attribute is optional and it is only relevant when the value +of sourceType is Offline.SourceType.PULL.

    • +

  • file_id (str) – File identifier returned by the file upload endpoint after file is +uploaded. +This attribute is optional and it is only relevant when the value +of sourceType is Offline.SourceType.PUSH.

    • +

  • owner (str or None) – Name of the user creating the depot. This attribute was added in +vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • ownerdata (str or None) – Private data saved by the owner of depot. It is opaque to vLCM. +This attribute was added in vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+create_from_host_task(spec)
+

Extract the current software specification applied to the host and +import it into the depot. Returns details about the current software +specification applied to the host. The result of this operation can be +queried by calling the cis/tasks/{task-id} where the task-id is the +response of this operation. This method was added in vSphere API +7.0.2.0.

+
+
Parameters
+

spec (Offline.ConnectionSpec) – ConnectionSpec connection spec for the host.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the Offline.HostCredentials attribute of spec is +invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no Offline.HostCredentials.host_name attribute +associated with host id in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the target node cannot be validated by +comparing with the thumbprint provided in +ConnectionSpec.HostCredentials#sslThumbPrint or the full +certificate provided in +ConnectionSpec.HostCredentials#sslCertificate.

+
+
+
+ +
+
+create_task(spec)
+

Imports a new offline software depot. This will also import the +metadata and payloads from this offline depot. The returned task will +fail and no offline depot would be created if there are any issues +during import. The result of this operation can be queried by calling +the cis/tasks/{task-id} where the task-id is the response of this +operation.

+
+
Parameters
+

spec (Offline.CreateSpec) – Specification to import an offline depot.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If an invalid Offline.CreateSpec.location is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If the depot content already exists. The value of the data +attribute of com.vmware.vapi.std.errors_client.Error will +be a class that contains existing depot identifier as part of depot +attribute defined in Offline.CreateResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+
+delete(depot)
+

The task-based delete method removes content of an imported offline +depot from vLCM completely. Note: The non task-based delete method +has been deprecated. It deletes only the record of depot from the list +of imported offline software depots, instead of removing the depot’s +content from vLCM.

+
+
Parameters
+

depot (str) – Identifier of the depot to be removed. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.offline.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the given depot is system-defined. This error is applicable to +the task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot associated with parameter depot in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of depot to be deleted is used in some baseline or +desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states. This error is applicable to the +task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. For task-based +delete method, once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +DeleteResult class that lists all the errors encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleDepots.Delete.

    • +
+
+
+
+ +
+
+delete_task(depot)
+

The task-based delete method removes content of an imported offline +depot from vLCM completely. Note: The non task-based delete method +has been deprecated. It deletes only the record of depot from the list +of imported offline software depots, instead of removing the depot’s +content from vLCM.

+
+
Parameters
+

depot (str) – Identifier of the depot to be removed. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.offline.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the given depot is system-defined. This error is applicable to +the task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot associated with parameter depot in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of depot to be deleted is used in some baseline or +desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states. This error is applicable to the +task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. For task-based +delete method, once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +DeleteResult class that lists all the errors encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleDepots.Delete.

    • +
+
+
+
+ +
+
+get(depot)
+

Gets the information about an imported offline software depot.

+
+
Parameters
+

depot (str) – Identifier for the depot. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.offline.

+
+
Return type
+

Offline.Info

+
+
Returns
+

Information about the imported offline software depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot with given identifier depot in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns currently imported offline software depots.

+
+
Return type
+

dict of str and Offline.Summary

+
+
Returns
+

Map of currently imported offline software depots keyed by their +identifier. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.depots.offline.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots_client.Online(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Online class provides methods to manage online software depots used +during ESX lifecycle management.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(description=None, location=None, enabled=None, ownerdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.CreateSpec class defines the information used to create a +depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str or None) – Description of the depot. +If None, the description will be empty.

    • +

  • location (str) – Location of the depot. It should be the location to the index.xml +for the depot.

    • +

  • enabled (bool or None) – Flag indicating whether this depot is enabled or not. Disabling the +depot doesn’t delete its cached metadata and payloads. It will not +be refreshed next time depots are re-synced. +If None, the depot will be enabled.

    • +

  • ownerdata (str or None) – Private data saved by the Online.Info.owner of the depot. +It is opaque to vLCM. This attribute was added in vSphere API +7.0.3.0. +If None, no ownerdata will be saved.

    • +
+
+
+
+ +
+
+class DeleteResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.DeleteResult class contains a field that lists all the +errors encountered after starting the task of Online.delete() method. +This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications returned by Online.delete() method. This +attribute was added in vSphere API 7.0.3.0. +If None, no notification is returned.

+
+
+
+ +
+
+class FlushResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.FlushResult class contains a field that lists all the errors +encountered after starting the task of Online.flush() method. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications returned by Online.flush() method. This +attribute was added in vSphere API 7.0.3.0. +If None, no notification is returned.

+
+
+
+ +
+
+class Info(description=None, location=None, enabled=None, system_defined=None, owner=None, ownerdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.Info class defines the information regarding a depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the depot. It will be an empty string if no +description was provided during create.

    • +

  • location (str) – Location of the depot.

    • +

  • enabled (bool) – Flag indicating whether this depot is enabled or not.

    • +

  • system_defined (bool) – Flag to indicate if the depot is system defined. System defined +depot can not be deleted.

    • +

  • owner (str or None) – Name of the user creating the depot. This attribute was added in +vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • ownerdata (str or None) – Private data saved by the owner of depot. It is opaque to vLCM. +This attribute was added in vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class PrecheckResult(affected_baselines=None, affected_desired_states=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.PrecheckResult class contains the fields that show the +details of affected baselines and desired states found in +Online.delete() or Online.flush() operation. This class was +added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • affected_baselines (list of AffectedBaselineInfo or None) – Baselines affected. This attribute was added in vSphere API +7.0.3.0. +If None, no baseline is affected.

    • +

  • affected_desired_states (list of AffectedDesiredStateInfo or None) – Desired states affected. This attribute was added in vSphere API +7.0.3.0. +If None, no desired state is affected.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.esx.settings.depots.online'
+

Resource type for depots resource

+
+ +
+
+class Summary(description=None, location=None, enabled=None, system_defined=None, owner=None, ownerdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.Summary class defines the summary information regarding a +depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the depot. It will be an empty string if no +description was provided during create.

    • +

  • location (str) – Location of the depot.

    • +

  • enabled (bool) – Flag indicating whether this depot is enabled or not.

    • +

  • system_defined (bool) – Flag to indicate if the depot is system defined. System defined +depot can not be deleted.

    • +

  • owner (str or None) – Name of the user creating the depot. This attribute was added in +vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • ownerdata (str or None) – Private data saved by the owner of depot. It is opaque to vLCM. +This attribute was added in vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class UpdateSpec(enabled=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Online.UpdateSpec class defines the information used to update the +depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) – Flag indicating whether this depot is enabled or not. Disabling the +depot doesn’t delete its cached metadata and payloads. It will not +be refreshed next time depots are re-synced. +If None, enabled flag is not updated.

    • +

  • description (str or None) – Description of the depot. +If None, description is not updated.

    • +
+
+
+
+ +
+
+create(spec)
+

Adds a new online software depot to the list of currently configured +online software depots.

+
+
Parameters
+

spec (Online.CreateSpec) – Depot information.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the currently configured online depot. +The return value will be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If an invalid location is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If depot with given location already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+
+delete(depot)
+

The task-based delete method removes content of a user-imported +online depot from vLCM completely. As a result, the URL of the +user-imported online depot will also be removed. Note: 1. To remove +content of system-defined online depots, use flush method. 2. The +non task-based delete method has been deprecated. It only deletes +the record of depot from the list of imported online software depots, +instead of removing the depot’s content from the system.

+
+
Parameters
+

depot (str) – Identifier of the depot to be removed. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the given depot is system-defined. This error is applicable to +the task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot associated with parameter depot in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of depot to be deleted is used in some baseline or +desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states. This error is applicable to the +task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. For task-based +delete method, once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +DeleteResult class that lists all the errors encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleDepots.Delete.

    • +
+
+
+
+ +
+
+delete_task(depot)
+

The task-based delete method removes content of a user-imported +online depot from vLCM completely. As a result, the URL of the +user-imported online depot will also be removed. Note: 1. To remove +content of system-defined online depots, use flush method. 2. The +non task-based delete method has been deprecated. It only deletes +the record of depot from the list of imported online software depots, +instead of removing the depot’s content from the system.

+
+
Parameters
+

depot (str) – Identifier of the depot to be removed. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the given depot is system-defined. This error is applicable to +the task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot associated with parameter depot in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of depot to be deleted is used in some baseline or +desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states. This error is applicable to the +task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. For task-based +delete method, once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +DeleteResult class that lists all the errors encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleDepots.Delete.

    • +
+
+
+
+ +
+
+flush_task(depot)
+

The task-based flush method removes content of a system-defined +online depot from vLCM completely. As a result, the system-defined +online depot will be disabled. Note: To remove content of user-imported +online depots, use the task-based delete method.

+
+
Parameters
+

depot (str) – Identifier of the depot to be removed. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the given depot is NOT system-defined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot associated with parameter depot in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of depot to be deleted is used in some baseline or +desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. flush is a +task-based method. Once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +FlushResult class that lists all the errors encountered.

+
+
+
+ +
+
+get(depot)
+

Gets the information about a currently configured online software +depot.

+
+
Parameters
+

depot (str) – Identifier for the depot. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

+
+
Return type
+

Online.Info

+
+
Returns
+

Information of the currently configured online software depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot with given identifier depot in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns a list of currently configured online software depots.

+
+
Return type
+

dict of str and Online.Summary

+
+
Returns
+

Map of currently configured online software depots keyed by their +identifiers. +The key in the return value dict will be an identifier for +the resource type: com.vmware.esx.settings.depots.online.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+update(depot, spec)
+

Updates the configuration of a currently configured online software +depot.

+
+
Parameters
+
    +

  • depot (str) – Identifier of the depot to be updated. +The parameter must be an identifier for the resource type: +com.vmware.esx.settings.depots.online.

    • +

  • spec (Online.UpdateSpec) – Update specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If given depot is system defined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot associated with parameter depot in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots_client.SolutionSummary(display_name=None, versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionSummary class contains fields that describe the summary of +a solution. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – Human readable name of the solution. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • versions (list of SolutionVersion) – Different versions of the solution. This attribute was added in +vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.SolutionVersion(version=None, display_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SolutionVersion class contains fields that describe a specific +version of a solution. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the solution. This attribute was added in vSphere API +7.0.3.0.

    • +

  • display_version (str) – Human readable version of the solution. This attribute was added in +vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.esx.settings.depots_client.SyncSchedule(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SyncSchedule class provides methods to manage Schedule of Online +Software Depot sync.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DayOfWeek(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SyncSchedule.DayOfWeek class contains the supported days of the +week.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DayOfWeek instance.

+
+
+
+
+FRIDAY = DayOfWeek(string='FRIDAY')
+

Friday.

+
+ +
+
+MONDAY = DayOfWeek(string='MONDAY')
+

Monday.

+
+ +
+
+SATURDAY = DayOfWeek(string='SATURDAY')
+

Saturday.

+
+ +
+
+SUNDAY = DayOfWeek(string='SUNDAY')
+

Sunday.

+
+ +
+
+THURSDAY = DayOfWeek(string='THURSDAY')
+

Thursday.

+
+ +
+
+TUESDAY = DayOfWeek(string='TUESDAY')
+

Tuesday.

+
+ +
+
+WEDNESDAY = DayOfWeek(string='WEDNESDAY')
+

Wednesday.

+
+ +
+ +
+
+class Recurrence(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SyncSchedule.Recurrence class contains the supported values for how +often to sync from online or UMDS depots.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Recurrence instance.

+
+
+
+
+DAILY = Recurrence(string='DAILY')
+

Daily.

+
+ +
+
+HOURLY = Recurrence(string='HOURLY')
+

Hourly.

+
+ +
+
+MONTHLY_BY_DAY = Recurrence(string='MONTHLY_BY_DAY')
+

Monthly by day.

+
+ +
+
+WEEKLY = Recurrence(string='WEEKLY')
+

Weekly.

+
+ +
+ +
+
+class Schedule(type=None, skip=None, minute=None, hour=None, day_of_month=None, day_of_week=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SyncSchedule.Schedule class defines a schedule.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Spec(enabled=None, schedule=None, email_addresses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SyncSchedule.Spec class defines the information regarding the sync +schedule.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool) – Flag indicating whether automatic sync is enabled or not

    • +

  • schedule (SyncSchedule.Schedule or None) – The schedule to check for new updates. +If None the schedule must be disabled.

    • +

  • email_addresses (list of str) – Email addresses to which the notification will be sent. If empty, +no notification is sent.

    • +
+
+
+
+ +
+
+get()
+

Returns the currently configured software depot sync schedule.

+
+
Return type
+

SyncSchedule.Spec

+
+
Returns
+

Currently configured sync schedule.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+set(spec=None)
+

Sets the software depot sync schedule.

+
+
Parameters
+

spec (SyncSchedule.Spec or None) – Information of the software depot sync schedule. +If None, it will be reset to the default schedule, which is daily +at a random hour chosen when this API is called.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If SyncSchedule.Spec.schedule is unset while +SyncSchedule.Spec.enabled is set to true or if any of the +values is not within valid range.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown error. The accompanying error message will +give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots_client.Umds(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Umds class provides methods to manage the VMware vSphere Update +Manager Download Service (UMDS) software depot used during ESX lifecycle +management. This is the depot downloaded using UMDS. If the UMDS depot is +specified, then online depots are ignored and data is downloaded only from +the UMDS depot.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DeleteResult(notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Umds.DeleteResult class contains a field that lists all the errors +encountered after starting the task of Umds.delete() method. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications returned by Umds.delete() method. This +attribute was added in vSphere API 7.0.3.0. +If None, no notification is returned.

+
+
+
+ +
+
+class Info(description=None, enabled=None, location=None, owner=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Umds.Info class defines the information regarding the UMDS Depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the depot. It will be an empty string if no +description was provided during create.

    • +

  • enabled (bool) – Flag indicating whether or not this depot is enabled.

    • +

  • location (str) – Location of the depot.

    • +

  • owner (str or None) – Name of the user creating the depot. This attribute was added in +vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class PrecheckResult(affected_baselines=None, affected_desired_states=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Umds.PrecheckResult class contains the fields that show the details +of affected baselines and desired states found in Umds.delete() +method. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • affected_baselines (list of AffectedBaselineInfo or None) – Baselines affected. This attribute was added in vSphere API +7.0.3.0. +If None, no baseline is affected.

    • +

  • affected_desired_states (list of AffectedDesiredStateInfo or None) – Desired states affected. This attribute was added in vSphere API +7.0.3.0. +If None, no desired state is affected.

    • +
+
+
+
+ +
+
+class SetSpec(description=None, enabled=None, location=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Umds.SetSpec class defines the information of an UMDS depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str or None) – Description of the depot. +If None, the description will be empty.

    • +

  • enabled (bool or None) – Flag indicating whether or not this depot should be enabled. +Disabling the depot doesn’t delete its cached metadata and +payloads. It will not be refreshed next time depots are re-synced. +If None, the depot will be enabled.

    • +

  • location (str) – Location of the depot. It should be the location to the index.xml +for the depot.

    • +
+
+
+
+ +
+
+class UpdateSpec(enabled=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Umds.UpdateSpec class defines the information used to update the +UMDS depot.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • enabled (bool or None) – Flag indicating whether or not this depot is enabled. Disabling the +depot doesn’t delete its cached metadata and payloads. It will not +be refreshed next time depots are re-synced. +If None, the enabled flag is not updated.

    • +

  • description (str or None) – Description of the depot. +If None, the description is not updated.

    • +
+
+
+
+ +
+
+delete()
+

The task-based delete method removes content of the UMDS depot from +vLCM completely. Note: The non task-based delete method has been +deprecated. It deletes only the record of UMDS depot from database, +instead of removing the content of UMDS depot from vLCM.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no UMDS depot configured in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of UMDS depot to be deleted is used in some baseline +or desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states. This error is applicable to the +task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. For task-based +delete method, once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +DeleteResult class that lists all the errors encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleDepots.Delete.

    • +
+
+
+
+ +
+
+delete_task()
+

The task-based delete method removes content of the UMDS depot from +vLCM completely. Note: The non task-based delete method has been +deprecated. It deletes only the record of UMDS depot from database, +instead of removing the content of UMDS depot from vLCM.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no UMDS depot configured in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +If the content of UMDS depot to be deleted is used in some baseline +or desired state. The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +PrecheckResult class that lists the information of affected +baselines and desired states. This error is applicable to the +task-based delete method only.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there some unknown internal error. The accompanying error +message will give more details about the failure. For task-based +delete method, once the task is started, it does NOT stop if +encountering an error. Instead, it will continuously run to +completion. In this case, the value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be the +DeleteResult class that lists all the errors encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleDepots.Delete.

    • +
+
+
+
+ +
+
+get()
+

Gets the information about a currently configured UMDS software depot.

+
+
Return type
+

Umds.Info

+
+
Returns
+

Information of the currently configured UMDS software depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no UMDS software depot set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+set(spec)
+

Sets or overwrites information about the UMDS software depot.

+
+
Parameters
+

spec (Umds.SetSpec) – Specification to set the UMDS depot.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If an invalid location is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+
+update(spec)
+

Updates the configuration of a currently configured UMDS software +depot.

+
+
Parameters
+

spec (Umds.UpdateSpec) – Update specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no UMDS depot configured.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.depots_client.UpdateSummary(summary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UpdateSummary class contains a fieldsthat describes the summary of +an update (bulletin). This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

summary (str) – Summary of the update (bulletin). This attribute was added in +vSphere API 7.0.3.0.

+
+
+
+ +
+
+

com.vmware.esx.settings.hardware_support_client module

+
+
+class com.vmware.esx.settings.hardware_support_client.Managers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Managers class provides methods to list Hardware Support Manager +(HSM) for a given vCenter.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HardwareSupportManagerInfo(manager=None, description=None, display_name=None, vendor=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Managers.HardwareSupportManagerInfo class contains attributes that +describe a particular 3rd party Hardware Support Manager (HSM)

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • manager (str) – Name of the Hardware Support Manager (HSM) (e.g. “Frobozz Hardware +Support Manager”) +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.manager. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.setting.hardware_support.manager.

    • +

  • description (str) – User-intelligible description of the HSM (e.g. “Front end for +Frobozz so-and-so management system”)

    • +

  • display_name (str) – UI label for HSM, derived from HSM extension’s description’s +‘label’ field. (e.g. “Frobozz Free Management System”)

    • +

  • vendor (str) – Company providing the Hardware Support Manager (HSM) (e.g. “Frobozz +Magic Software Company”)

    • +
+
+
+
+ +
+
+list()
+

Returns the list of registered Hardware Support Managers (HSMs) in the +system.

+
+
Return type
+

list of Managers.HardwareSupportManagerInfo

+
+
Returns
+

List of currently registered Hardware Support Manager (HSMs)

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hardware_support_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.esx.settings.hosts_client module

+

The com.vmware.esx.settings.hosts_client module provides classes to manage +desired state configuration and software for a standalone ESX host.

+
+
+class com.vmware.esx.settings.hosts_client.Configuration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Configuration class provides methods to manage configuration of a +ESX host. This class was added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ExtractResult(config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class defines the information about configuration extracted +from a ESXi host. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

config (str) – ESXi host configuration encoded as JSON. This attribute was added +in vSphere API 8.0.1.0.

+
+
+
+ +
+
+extract(host)
+

Extracts a configuration document from the ESXi host,. This method was +added in vSphere API 8.0.1.0.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Configuration.ExtractResult

+
+
Returns
+

The result contains the configuration of the ESXi host encoded as +JSON.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.ClusterConfiguration.Modify.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.ClusterConfiguration.Modify.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts_client.DepotOverrides(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DepotOverrides class provides methods to manage software depots +overriden for a given host. In general ESX servers reach out to vCenter +(VUM) to fetch the metadata and payloads required for lifecycle operations. +But in ROBO environments ESX hosts can’t (or because of bandwidth +requirements shouldn’t) reach out to vCenter to fetch payloads and +metadata. This class allows setting host level overrides for depots. If any +depots are provided for a host, then vCenter level depots are not used for +that host’s remediation. These are not synced periodically at vCenter and +are only used by ESXs for lifecycle operations. This class was added in +vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Depot(location=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DepotOverrides.Depot class defines the information regarding a +particular depot override for a given host. This class was added in vSphere +API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

location (str) – Location of the depot override. This could be a location of zip +file or location to an index.xml file. This attribute was added in +vSphere API 8.0.1.0.

+
+
+
+ +
+
+class Info(depots=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DepotOverrides.Info class defines the information regarding depot +overrides for a given host. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

depots (list of DepotOverrides.Depot) – List of the depot overrides. This attribute was added in vSphere +API 8.0.1.0.

+
+
+
+ +
+
+add(host, depot)
+

Adds a new depot override to the list of currently configured depot +overrides for a given host. This method was added in vSphere API +8.0.1.0.

+
+
Parameters
+
    +

  • host (str) – Identifier for the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • depot (DepotOverrides.Depot) – Information of a depot override.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If an invalid location is provided.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if depot override with given information already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+
+get(host)
+

Returns the information about currently configured depot overrides for +a given host. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

host (str) – Identifier for the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

DepotOverrides.Info

+
+
Returns
+

Information about currently configured depot overrides for a given +host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Read.

    • +
+
+
+
+ +
+
+remove(host, depot)
+

Removes a depot override from the list of currently configured depot +overrides for a given host. This method was added in vSphere API +8.0.1.0.

+
+
Parameters
+
    +

  • host (str) – Identifier for the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • depot (DepotOverrides.Depot) – Information of the depot override to be removed.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no depot override with given information or no host +associated with identifier {param.name host} in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSettings.Write.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSettings.Write.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts_client.Software(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Software class provides methods to manage desired software +specification of a standalone ESX host.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplyResult(status=None, commit=None, host_info=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ApplyResult class contains attributes that describe the +result of an Software.apply() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.ApplyStatus or None) – Specifies the aggregated status of the Software.apply() +method. This attribute was added in vSphere API 8.0.0.1. +None if the Software.apply() method is in progress.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired software +document to be applied to host. This attribute was added in vSphere +API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information of the host to which the desired software document +specified by the Software.ApplyResult.commit was applied. +This attribute was added in vSphere API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for +Software.apply() method. These notifications are mutually +exclusive with the notifications in Software.ApplyStatus. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class ApplySpec(commit=None, accept_eula=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ApplySpec class contains attributes that describe the +specification to be used for applying the desired software document to a +host. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • commit (str or None) – The minimum commit identifier of the desired software document to +be used during the Software.apply() method. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the apply method will use the latest commit to +fetch the desired state document.

    • +

  • accept_eula (bool or None) – Accept the VMware End User License Agreement (EULA) before starting +the Software.apply() method. The VMware EULA is available for +download at, https://www.vmware.com/download/eula.html. This +attribute was added in vSphere API 8.0.0.1. +if None the Software.apply() method could fail due to the +EULA not being accepted.

    • +
+
+
+
+ +
+
+class ApplyStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ApplyStatus class contains attributes that describe the +status of an Software.apply() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.ApplyStatus.Status) – The status of the method. This attribute was added in vSphere API +8.0.0.1.

    • +

  • progress (com.vmware.cis.task_client.Progress or None) – Progress of the operation. This attribute was added in vSphere API +8.0.0.1. +None for host ApplyStatus

    • +

  • start_time (datetime.datetime) – Time when the method started. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • end_time (datetime.datetime) – Time when the method completed. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of +the method. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.ApplyStatus.Status class contains the possible different +status codes that can be returned while trying to Software.apply() +the desired software specification to host. This enumeration was added in +vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+RETRY_PENDING = Status(string='RETRY_PENDING')
+

The method is being scheduled for retry. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The method is in progress. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+ +
+
+class CheckInfo(check=None, name=None, description=None, originator=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckInfo class contains attributes that describe a +particular check. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check (str) – The check identifier. This attribute was added in vSphere API +8.0.0.1.

    • +

  • name (com.vmware.vapi.std_client.LocalizableMessage) – The check name. This attribute was added in vSphere API 8.0.0.1.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Human-readable check description. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • originator (str or None) – The service that performed the check. This attribute was added in +vSphere API 8.0.0.1. +Only set if there is an originator available for this +check.

    • +
+
+
+
+ +
+
+class CheckIssue(description=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of what was the issue containing as much user-relevant +context as possible. The user should be able to understand which +sub-system failed and why. This attribute was added in vSphere API +8.0.0.1.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – Possible resolution for the issue. This should contain actionable +information that the user can use to resolve the issue. This +attribute was added in vSphere API 8.0.0.1. +Can be left None if no meaningful resolution exists.

    • +
+
+
+
+ +
+
+class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckResult class contains attributes that describe +aggregated status of all checks performed. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.Status) – Aggregated status from all checks performed. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • start_time (datetime.datetime) – Time when the operation started. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • end_time (datetime.datetime) – Time when the operation completed. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • commit (str) – The identifier of the commit on which checks have been run. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information about the host for which checks have been requested to +be run. This attribute was added in vSphere API 8.0.0.1.

    • +

  • entity_result (Software.EntityCheckResult) – List of Software.EntityCheckResult for all entities for which +checks have been run. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+class CheckSpec(commit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckSpec class contains attributes that describe the +specification to be used for running checks on the host before the +Software.apply() method. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

commit (str or None) – The minimum commit identifier of the desired software document to +be used during the check method. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the check opertion will use the latest commit to +fetch the desired state document.

+
+
+
+ +
+
+class CheckStatus(check=None, status=None, check_issues=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.CheckStatus class contains attributes that describe a +check result. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • check (Software.CheckInfo) – Information about this check. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • status (Software.Status) – The status of this check. This attribute was added in vSphere API +8.0.0.1.

    • +

  • check_issues (list of Software.CheckIssue or None) – List of Software.CheckIssue`s that the check reported. This +attribute was added in vSphere API 8.0.0.1. +If not :class:`set, the service is still using the {#member +issues}.

    • +
+
+
+
+ +
+
+class EntityCheckResult(type=None, host=None, status=None, check_statuses=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.EntityCheckResult class contains attributes that describe +aggregated status of all checks performed on a specific entity. This class +was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Software.EntityCheckResult.EntityType) – The entity type for which these checks are being run. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • host (str) – If the entity type is HOST then the host identifier for which the +checks have been run. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of type is Software.EntityCheckResult.EntityType.HOST.

    • +

  • status (Software.Status) – Aggregated status from all checks performed on this entity. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • check_statuses (list of Software.CheckStatus) – List of Software.CheckStatus for all checks performed. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class EntityType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.EntityCheckResult.EntityType class contains the entitites +on which checks can be performed. This enumeration was added in vSphere API +8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EntityType instance.

+
+
+
+
+HOST = EntityType(string='HOST')
+

Entity type Host. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class ExportSpec(export_software_spec=None, export_iso_image=None, export_offline_bundle=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.ExportSpec class contains information describing how a +software specification or image should be exported. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • export_software_spec (bool) – Whether to export software specification document. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • export_iso_image (bool) – Whether to export ISO image. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • export_offline_bundle (bool) – Whether to export offline bundle. This attribute was added in +vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class ExportType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.ExportType class defines the formats in which software +specification document or image can be exported. This enumeration was added +in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ExportType instance.

+
+
+
+
+ISO_IMAGE = ExportType(string='ISO_IMAGE')
+

Export ISO image. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+OFFLINE_BUNDLE = ExportType(string='OFFLINE_BUNDLE')
+

Export offline bundle. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SOFTWARE_SPEC = ExportType(string='SOFTWARE_SPEC')
+

Export software specification document. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+ +
+
+class StageResult(status=None, commit=None, host_info=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.StageResult class contains attributes that describe the +result of a Software.stage() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.StageStatus or None) – Specifies the status of the Software.stage() method on the +specified Software.StageResult.commit of the desired +software document. This attribute was added in vSphere API 8.0.0.1. +None if the Software.stage() method is in progress.

    • +

  • commit (str) – The identifier of the commit used to fetch the desired software +document to be staged to a host. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit.

    • +

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information of the host to which the desired software document +specified by the Software.StageResult.commit was staged. +This attribute was added in vSphere API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for +Software.stage() method. These notifications are mutually +exclusive with the notifications in Software.StageStatus. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class StageSpec(commit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.StageSpec class contains attributes that describe the +specification to be used for staging the desired software document to a +host. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

commit (str or None) – The minimum commit identifier of the desired software document to +be used during the Software.stage() method. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.settings.commit. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.esx.settings.commit. +if None or empty the stage method will use the latest commit to +fetch the desired state document.

+
+
+
+ +
+
+class StageStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Software.StageStatus class contains attributes that describe the +status of a Software.stage() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Software.StageStatus.Status) – The status of the method. This attribute was added in vSphere API +8.0.0.1.

    • +

  • progress (com.vmware.cis.task_client.Progress or None) – Progress of the operation. This attribute was added in vSphere API +8.0.0.1. +None for host StageStatus

    • +

  • start_time (datetime.datetime) – Time when the method started. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • end_time (datetime.datetime) – Time when the method completed. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of +the method. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.StageStatus.Status class contains the possible different +status codes that can be returned while trying to Software.stage() +the desired software specification to a host. This enumeration was added in +vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The method encountered an unspecified error. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+OK = Status(string='OK')
+

The method completed successfully. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+RETRY_PENDING = Status(string='RETRY_PENDING')
+

The method is being scheduled for retry. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The method is in progress. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SKIPPED = Status(string='SKIPPED')
+

The method was skipped. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

The method timed out. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Software.Status class defines the status result for a particular +check. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+ERROR = Status(string='ERROR')
+

The check indicates an error. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+OK = Status(string='OK')
+

The check indicates a success. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+RETRY = Status(string='RETRY')
+

The check failed because of an intermittent error, for example a service is +overloaded. The client can choose to retry the health check before +considering the check as failed. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+
+TIMEOUT = Status(string='TIMEOUT')
+

The check did not return in a timely manner. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+WARNING = Status(string='WARNING')
+

The check indicates a warning. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+ +
+
+apply_task(host, spec)
+

Applies the desired software document associated with the given host. +If commit attribute is set, it implies the minimum commit +that the Software.apply() method should use, however if +subsequent commits have been made to the desired state document the +apply method will use the most recent desired state document. The +result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Software.ApplySpec) – Apply specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +If the host is already at specified commit as described in the +apply specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error or if the EULA has not been +accepted. The accompanying error message will give more details +about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the commit attribute of spec specifies an invalid +commit.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the operation times out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+check_task(host, spec)
+

Runs checks on the host before applying the desired software document. +Checks if host is in a good state to be updated with the desired +software document. If commit attribute is set it implies +the minimum commit that the check method should use, however if +subsequent commits have been made to the desired state document the +check method will use the most recent desired state document. The +result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Software.CheckSpec) – Check specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the commit attribute of spec specifies an invalid +commit.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress or if the commit +attribute of spec specifies a commit that has already been +applied.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the operation times out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+export(host, spec)
+

Exports the desired software specification document and/or image. This +API will not export the solution section of the desired software +specification. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Software.ExportSpec) –

    • +
+
+
Return type
+

dict of Software.ExportType and str

+
+
Returns
+

A map from export type to URL of the exported data for that type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is am unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+get(host)
+

Returns the complete desired software specification. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

com.vmware.esx.settings_client.SoftwareInfo

+
+
Returns
+

Host software specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +

  • The resource HostSystem referenced by the parameter host +requires VcIntegrity.lifecycleSoftwareSpecification.Read.

    • +
+
+
+
+ +
+
+scan_task(host)
+

Scans the host against the host’s desired state.. The result of this +operation can be queried by calling the cis/tasks/{task-id} where the +task-id is the response of this operation.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is unknown internal error. The accompanying error message +will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host.

+
+
+
+ +
+
+stage_task(host, spec)
+

Stages the desired software document associated with the given host. If +commit attribute is set, it implies the minimum commit +that the Software.stage() method should use, however if +subsequent commits have been made to the desired state document the +stage method will use the most recent desired state document. The +result of this operation can be queried by calling the +cis/tasks/{task-id} where the task-id is the response of this +operation. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (Software.StageSpec) – stage specification.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is an unknown internal error. The accompanying error +message will give more details about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the commit attribute of spec specifies an invalid +commit, or the StageSpec#hosts attribute of spec specifies +an invalid host or the host is not managed with a single +software specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If there is another operation in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no host associated with host in the system or if +desired software document is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the service is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +If the operation times out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the host is not a vLCM managed standlone host

+
+
+
+ +
+ +
+
+class com.vmware.esx.settings.hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.html b/vsphere/8.0.2.0/com.vmware.html new file mode 100644 index 00000000..945af81a --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.html @@ -0,0 +1,13624 @@ + + + + + + + com.vmware package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.appliance_client module

+

The com.vmware.appliance_client module provides classes for managing +vCenter Appliance configuration. The module is available starting in vSphere +6.5.

+
+
+class com.vmware.appliance_client.Health(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Health class provides methods to retrieve the appliance health +information. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+messages(item)
+

Get health messages. This method was added in vSphere API 6.7.

+
+
Parameters
+

item (str) – ID of the data item +The parameter must be an identifier for the resource type: +com.vmware.appliance.health.

+
+
Return type
+

list of Notification

+
+
Returns
+

List of the health messages

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +Unknown health item

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.HealthCheckSettings(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The HealthCheckSettings class provides methods to enable/disable health +check settings in vCenter Server. This class was added in vSphere API +7.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class SettingSpec(db_health_check_state_manual_backup=None, db_health_check_state_scheduled_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HealthCheckSettings.SettingSpec class contains specification of vCenter +Server health and its corresponding state. This class was added in vSphere +API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • db_health_check_state_manual_backup (bool) – Health check state of database during manual backup with this +option set, the health status of the particular health check will +be reported. This attribute was added in vSphere API 7.0.0.1.

    • +

  • db_health_check_state_scheduled_backup (bool) – Health check state of database during schedule backup with this +option set, the health status of the particular health check will +be reported. This attribute was added in vSphere API 7.0.0.1.

    • +
+
+
+
+ +
+
+class UpdateSpec(db_health_check_state_manual_backup=None, db_health_check_state_scheduled_backup=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • db_health_check_state_manual_backup (bool or None) – Health check state of database during manual backup with this +option set, the health status of the particular health check will +be enabled. This attribute was added in vSphere API 7.0.0.1. +If None the current state will remain unchanged.

    • +

  • db_health_check_state_scheduled_backup (bool or None) – Health check state of database during schedule backup with this +option set, the health status of the particular health check will +be enabled. This attribute was added in vSphere API 7.0.0.1. +If None the current state will remain unchanged.

    • +
+
+
+
+ +
+
+get()
+

Get health settings for vCenter Server. This method was added in +vSphere API 7.0.0.1.

+
+
Return type
+

HealthCheckSettings.SettingSpec

+
+
Returns
+

health settings.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+update(health_settings)
+

Set health settings based on provided healthSpec. This method was added +in vSphere API 7.0.0.1.

+
+
Parameters
+

health_settings (HealthCheckSettings.UpdateSpec) –

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.LocalAccounts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LocalAccounts class provides methods to manage local user account. +This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Config(password=None, old_password=None, full_name=None, email=None, roles=None, enabled=None, password_expires=None, password_expires_at=None, inactive_after_password_expiration=None, days_after_password_expiration=None, min_days_between_password_change=None, max_days_between_password_change=None, warn_days_before_password_expiration=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalAccounts.Config class defines the information required for the +account. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • password (str) – Password. This attribute was added in vSphere API 6.7.

    • +

  • old_password (str or None) – Old password of the user (required in case of the password change, +not required if superAdmin user changes the password of the other +user). This attribute was added in vSphere API 6.7. +If None, user may not have password set.

    • +

  • full_name (str or None) – Full name of the user. This attribute was added in vSphere API 6.7. +If None, user will have no fullname.

    • +

  • email (str or None) – Email address of the local account. This attribute was added in +vSphere API 6.7. +If None, user will have no email.

    • +

  • roles (list of str) – User roles. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.roles. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.appliance.roles.

    • +

  • enabled (bool or None) – Flag indicating if the account is enabled. This attribute was added +in vSphere API 6.7. +If None, defaults to True

    • +

  • password_expires (bool or None) – Flag indicating if the account password expires. This attribute was +added in vSphere API 6.7. +If None, defaults to True.

    • +

  • password_expires_at (datetime.datetime or None) – Date when the account’s password will expire. This attribute was +added in vSphere API 6.7. +If None, will be taken from system defaults (see +local-accounts/policy).

    • +

  • inactive_after_password_expiration (bool or None) – Flag indicating if the account will be locked after password +expiration. This attribute was added in vSphere API 6.7. +If None, defaults to True.

    • +

  • days_after_password_expiration (long or None) – Number of days after password expiration before the account will be +locked. This attribute was added in vSphere API 6.7. +If None, will be taken from system defaults (see +local-accounts/policy).

    • +

  • min_days_between_password_change (long or None) – Minimum number of days between password change. This attribute was +added in vSphere API 6.7. +If None, will be taken from system defaults (see +local-accounts/policy).

    • +

  • max_days_between_password_change (long or None) – Maximum number of days between password change. This attribute was +added in vSphere API 6.7. +If None, will be taken from system defaults (see +local-accounts/policy).

    • +

  • warn_days_before_password_expiration (long or None) – Number of days of warning before password expires. This attribute +was added in vSphere API 6.7. +If None, will be taken from system defaults (see +local-accounts/policy).

    • +
+
+
+
+ +
+
+class Info(fullname=None, email=None, roles=None, enabled=None, has_password=None, last_password_change=None, password_expires_at=None, inactive_at=None, min_days_between_password_change=None, max_days_between_password_change=None, warn_days_before_password_expiration=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalAccounts.Info class defines the local account properties. This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • fullname (str or None) – Full name of the user. This attribute was added in vSphere API 6.7. +If None, the value was never set.

    • +

  • email (str or None) – Email address of the local account. This attribute was added in +vSphere API 6.7. +If None, the value was never set.

    • +

  • roles (list of str) – User roles. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.roles. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.appliance.roles.

    • +

  • enabled (bool) – Flag indicating if the account is enabled. This attribute was added +in vSphere API 6.7.

    • +

  • has_password (bool) – Is the user password set. This attribute was added in vSphere API +6.7.

    • +

  • last_password_change (datetime.datetime or None) – Date and time password was changed. This attribute was added in +vSphere API 6.7. +If None, the password was never set.

    • +

  • password_expires_at (datetime.datetime or None) – Date when the account’s password will expire. This attribute was +added in vSphere API 6.7. +If None, the password never expires.

    • +

  • inactive_at (datetime.datetime or None) – Date and time account will be locked after password expiration. +This attribute was added in vSphere API 6.7. +If None, account will not be locked.

    • +

  • min_days_between_password_change (long or None) – Minimum number of days between password change. This attribute was +added in vSphere API 6.7. +If None, pasword can be changed any time.

    • +

  • max_days_between_password_change (long or None) – Maximum number of days between password change. This attribute was +added in vSphere API 6.7. +If None, password never expires.

    • +

  • warn_days_before_password_expiration (long or None) – Number of days of warning before password expires. This attribute +was added in vSphere API 6.7. +If None, a user is never warned.

    • +
+
+
+
+ +
+
+class UpdateConfig(password=None, old_password=None, full_name=None, email=None, roles=None, enabled=None, password_expires=None, password_expires_at=None, inactive_after_password_expiration=None, days_after_password_expiration=None, min_days_between_password_change=None, max_days_between_password_change=None, warn_days_before_password_expiration=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalAccounts.UpdateConfig class defines the fields that might be +updated. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • password (str or None) – Password. This attribute was added in vSphere API 6.7. +If None, value will not be changed

    • +

  • old_password (str or None) – Old password of the user (required in case of the password change, +not required if superAdmin user changes the password of the other +user). This attribute was added in vSphere API 6.7. +If None, user may not have password set.

    • +

  • full_name (str or None) – Full name of the user. This attribute was added in vSphere API 6.7. +If None, value will not be changed

    • +

  • email (str or None) – Email address of the local account. This attribute was added in +vSphere API 6.7. +If None, value will not be changed

    • +

  • roles (list of str or None) – User roles. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.roles. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.appliance.roles. +If None, value will not be changed

    • +

  • enabled (bool or None) – Flag indicating if the account is enabled. This attribute was added +in vSphere API 6.7. +If None, value will not be changed

    • +

  • password_expires (bool or None) – Flag indicating if the account password expires. This attribute was +added in vSphere API 6.7. +If None, value will not be changed

    • +

  • password_expires_at (datetime.datetime or None) – Date when the account’s password will expire. This attribute was +added in vSphere API 6.7. +If None, value will not be changed

    • +

  • inactive_after_password_expiration (bool or None) – Flag indicating if the account will be locked after password +expiration. This attribute was added in vSphere API 6.7. +If None, value will not be changed

    • +

  • days_after_password_expiration (long or None) – Number of days after password expiration before the account will be +locked. This attribute was added in vSphere API 6.7. +If None, value will not be changed

    • +

  • min_days_between_password_change (long or None) – Minimum number of days between password change. This attribute was +added in vSphere API 6.7. +If None, value will not be changed

    • +

  • max_days_between_password_change (long or None) – Maximum number of days between password change. This attribute was +added in vSphere API 6.7. +If None, value will not be changed

    • +

  • warn_days_before_password_expiration (long or None) – Number of days of warning before password expires. This attribute +was added in vSphere API 6.7. +If None, value will not be changed

    • +
+
+
+
+ +
+
+create(username, config)
+

Create a new local user account. This method was added in vSphere API +6.7.

+
+
Parameters
+
    +

  • username (str) – User login name +The parameter must be an identifier for the resource type: +com.vmware.appliance.local_accounts.

    • +

  • config (LocalAccounts.Config) – User configuration

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If an account already exists

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If a username is invalid (username is validated against +[a-zA-Z0-9][a-zA-Z0-9-.\@]*[a-zA-Z0-9] pattern)

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+delete(username)
+

Delete a local user account. This method was added in vSphere API 6.7.

+
+
Parameters
+

username (str) – User login name +The parameter must be an identifier for the resource type: +com.vmware.appliance.local_accounts.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the account is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+get(username)
+

Get the local user account information. This method was added in +vSphere API 6.7.

+
+
Parameters
+

username (str) – User login name

+
+
Return type
+

LocalAccounts.Info

+
+
Returns
+

Local user account information

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the account is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+list()
+

Get a list of the local user accounts. This method was added in vSphere +API 6.7.

+
+
Return type
+

list of str

+
+
Returns
+

List of identifiers +The return value will contain identifiers for the resource type: +com.vmware.appliance.local_accounts.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(username, config)
+

Set local user account properties. This method was added in vSphere API +6.7.

+
+
Parameters
+
    +

  • username (str) – User login name +The parameter must be an identifier for the resource type: +com.vmware.appliance.local_accounts.

    • +

  • config (LocalAccounts.Config) – User configuration

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the account is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+update(username, config)
+

Update selected fields in local user account properties. This method +was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • username (str) – User login name +The parameter must be an identifier for the resource type: +com.vmware.appliance.local_accounts.

    • +

  • config (LocalAccounts.UpdateConfig) – User configuration

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the account is not found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Monitoring(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Monitoring class provides methods Get and list monitoring data for +requested item.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FunctionType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Monitoring.FunctionType class Defines aggregation function

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the FunctionType instance.

+
+
+
+
+AVG = FunctionType(string='AVG')
+

Aggregation takes average per period

+
+ +
+
+COUNT = FunctionType(string='COUNT')
+

Aggregation takes count per period (sum)

+
+ +
+
+MAX = FunctionType(string='MAX')
+

Aggregation takes maximums per period

+
+ +
+
+MIN = FunctionType(string='MIN')
+

Aggregation takes minimums per period

+
+ +
+ +
+
+class IntervalType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Monitoring.IntervalType class Defines interval between the values in +hours and mins, for which aggregation will apply

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IntervalType instance.

+
+
+
+
+DAY1 = IntervalType(string='DAY1')
+

24 hours interval between values. One year has 365 values.

+
+ +
+
+HOURS2 = IntervalType(string='HOURS2')
+

Two hours interval between values. One month has 360 values.

+
+ +
+
+HOURS6 = IntervalType(string='HOURS6')
+

Six hour interval between values. One quarter is 360 values.

+
+ +
+
+MINUTES30 = IntervalType(string='MINUTES30')
+

Thirty minutes interval between values. One week is 336 values.

+
+ +
+
+MINUTES5 = IntervalType(string='MINUTES5')
+

Five minutes interval between values (finest). One day would have 288 +values, one week is 2016.

+
+ +
+ +
+
+class MonitoredItem(id=None, name=None, units=None, category=None, instance=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Monitoring.MonitoredItem class Structure representing requested +monitored item data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – monitored item ID Ex: CPU, MEMORY +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.monitoring. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.appliance.monitoring.

    • +

  • name (str) – monitored item name Ex: “Network write speed”

    • +

  • units (str) – Y-axis label EX: “Mbps”, “%”

    • +

  • category (str) – category Ex: network, storage etc

    • +

  • instance (str) – instance name Ex: eth0

    • +

  • description (str) – monitored item description Ex: +com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0

    • +
+
+
+
+ +
+
+class MonitoredItemData(name=None, interval=None, function=None, start_time=None, end_time=None, data=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Monitoring.MonitoredItemData class Structure representing monitored +item data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Monitored item IDs Ex: CPU, MEMORY, STORAGE_TOTAL +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.appliance.monitoring. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.appliance.monitoring.

    • +

  • interval (Monitoring.IntervalType) – interval between values in hours, minutes

    • +

  • function (Monitoring.FunctionType) – aggregation function

    • +

  • start_time (datetime.datetime) – Start time in UTC

    • +

  • end_time (datetime.datetime) – End time in UTC

    • +

  • data (list of str) – list of values

    • +
+
+
+
+ +
+
+class MonitoredItemDataRequest(names=None, interval=None, function=None, start_time=None, end_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Monitoring.MonitoredItemDataRequest class Structure representing +requested monitored item data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • names (list of str) – monitored item IDs Ex: CPU, MEMORY +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.appliance.monitoring. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.appliance.monitoring.

    • +

  • interval (Monitoring.IntervalType) – interval between values in hours, minutes

    • +

  • function (Monitoring.FunctionType) – aggregation function

    • +

  • start_time (datetime.datetime) – Start time in UTC

    • +

  • end_time (datetime.datetime) – End time in UTC

    • +
+
+
+
+ +
+
+get(stat_id)
+

Get monitored item info

+
+
Parameters
+

stat_id (str) – statistic item id +The parameter must be an identifier for the resource type: +com.vmware.appliance.monitoring.

+
+
Return type
+

Monitoring.MonitoredItem

+
+
Returns
+

MonitoredItem structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+list()
+

Get monitored items list

+
+
Return type
+

list of Monitoring.MonitoredItem

+
+
Returns
+

list of names

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+query(item)
+

Get monitoring data.

+
+
Parameters
+

item (Monitoring.MonitoredItemDataRequest) – MonitoredItemDataRequest Structure

+
+
Return type
+

list of Monitoring.MonitoredItemData

+
+
Returns
+

list of MonitoredItemData structure

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Networking(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Networking class provides methods Get Network configurations. This +class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ChangeSpec(hostname=None, sso_user=None, sso_password=None, dns=None, ipv4=None, ipv6=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – New hostname to assign to the management network of vCenter +appliance. This attribute was added in vSphere API 6.7.3.

    • +

  • sso_user (str) – vCenter Server SSO administrator username. This attribute was added +in vSphere API 6.7.3.

    • +

  • sso_password (str) – vCenter Server SSO administrator Password. This attribute was added +in vSphere API 6.7.3.

    • +

  • dns (com.vmware.appliance.networking.dns_client.Servers.DNSServerConfig or None) – DNS Configuration to set for the machine. This attribute was added +in vSphere API 6.7.3. +If None DNS settings will not be changed

    • +

  • ipv4 (com.vmware.appliance.networking.interfaces_client.Ipv4.Config or None) – IPv4 Configuration to set for the machine. This attribute was added +in vSphere API 6.7.3. +If None IPv4 settings will not be changed

    • +

  • ipv6 (com.vmware.appliance.networking.interfaces_client.Ipv6.Config or None) – IPv6 Configuration to set for the machine. This attribute was added +in vSphere API 6.7.3. +If None IPv6 settings will not be changed

    • +
+
+
+
+ +
+
+class DNSInfo(mode=None, hostname=None, servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networking.DNSInfo class contains information about the DNS +configuration of a virtual appliance. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mode (Networking.DNSInfo.DNSMode) – DNS mode. This attribute was added in vSphere API 6.7.

    • +

  • hostname (str) – Hostname. This attribute was added in vSphere API 6.7.

    • +

  • servers (list of str) – Servers. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+
+class DNSMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Networking.DNSInfo.DNSMode class describes the source of DNS +servers. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DNSMode instance.

+
+
+
+
+DHCP = DNSMode(string='DHCP')
+

The DNS servers addresses are obtained from a DHCP server. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+STATIC = DNSMode(string='STATIC')
+

The DNS servers addresses are specified explicitly. This class attribute +was added in vSphere API 6.7.

+
+ +
+ +
+ +
+
+class Info(dns=None, interfaces=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networking.Info class contains information about the network +configuration of a virtual appliance. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dns (Networking.DNSInfo) – DNS configuration. This attribute was added in vSphere API 6.7.

    • +

  • interfaces (dict of str and com.vmware.appliance.networking_client.Interfaces.InterfaceInfo) – Interface configuration as a key-value map where key is a network +interface name, for example, “nic0”. This attribute was added in +vSphere API 6.7. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.appliance.networking.interfaces. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.appliance.networking.interfaces.

    • +
+
+
+
+ +
+
+class UpdateSpec(ipv6_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networking.UpdateSpec class describes whether to enable or disable +ipv6 on interfaces. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ipv6_enabled (bool or None) – IPv6 Enabled or not. This attribute was added in vSphere API 6.7. +If unspecified, leaves the current state of Ipv6.

+
+
+
+ +
+
+change_task(spec)
+

Changes the Hostname/IP of the management network of vCenter appliance. +The Hostname/IP change invokes the PNID change process which involves +LDAP entry modification, updating registry entries, configuration files +modification and network configuration changes. vCenter server is +expected to be down for few minutes during these changes. This method +was added in vSphere API 6.7.3.

+
+
Parameters
+

spec (Networking.ChangeSpec) – Information required to change the hostname.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if it’s not embedded node

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if another change task is in progress

+
+
+
+ +
+
+get()
+

Get Networking information for all configured interfaces. This method +was added in vSphere API 6.7.

+
+
Return type
+

Networking.Info

+
+
Returns
+

The Map of network configuration info for all interfaces.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+reset()
+

Reset and restarts network configuration on all interfaces, also this +will renew the DHCP lease for DHCP IP address. This method was added in +vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+update(spec)
+

Enable or Disable ipv6 on all interfaces. This method was added in +vSphere API 6.7.

+
+
Parameters
+

spec (Networking.UpdateSpec) – update spec with optional boolean value

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Notification(id=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class describes a notification that can be reported by +the appliance task. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The notification id. This attribute was added in vSphere API 6.7.

    • +

  • time (datetime.datetime or None) – The time the notification was raised/found. This attribute was +added in vSphere API 6.7. +Only if the time information is available.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message. This attribute was added in vSphere API +6.7.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. This attribute was added in vSphere +API 6.7. +Only set for warnings and errors.

    • +
+
+
+
+ +
+
+class com.vmware.appliance_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the appliance task. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. This attribute was added in +vSphere API 6.7. +Only set if an info was reported by the appliance task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. This attribute was added in +vSphere API 6.7. +Only set if an warning was reported by the appliance task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. This attribute was added in +vSphere API 6.7. +Only set if an error was reported by the appliance task.

    • +
+
+
+
+ +
+
+class com.vmware.appliance_client.Ntp(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Ntp class provides methods Gets NTP configuration status and tests +connection to ntp servers. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class LocalizableMessage(id=None, default_message=None, args=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ntp.LocalizableMessage class Structure representing message. This class +was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – id in message bundle. This attribute was added in vSphere API 6.7.

    • +

  • default_message (str) – text in english. This attribute was added in vSphere API 6.7.

    • +

  • args (list of str) – nested data. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class ServerStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Ntp.ServerStatus class Status of server during test. This enumeration +was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ServerStatus instance.

+
+
+
+
+SERVER_REACHABLE = ServerStatus(string='SERVER_REACHABLE')
+

Server is reachable. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SERVER_UNREACHABLE = ServerStatus(string='SERVER_UNREACHABLE')
+

Server is unreachable. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class TestRunStatus(server=None, status=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Ntp.TestRunStatus class Status of the test. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server (str) – Server name associated with the test run. This attribute was added +in vSphere API 6.7.

    • +

  • status (Ntp.ServerStatus) – Server status. This attribute was added in vSphere API 6.7.

    • +

  • message (Ntp.LocalizableMessage) – Message associated with status. This attribute was added in vSphere +API 6.7.

    • +
+
+
+
+ +
+
+get()
+

Get the NTP configuration status. If you run the ‘timesync.get’ +command, you can retrieve the current time synchronization method (NTP- +or VMware Tools-based). The ‘ntp’ command always returns the NTP server +information, even when the time synchronization mode is not set to NTP. +If the time synchronization mode is not NTP-based, the NTP server +status is displayed as down. This method was added in vSphere API 6.7.

+
+
Return type
+

list of str

+
+
Returns
+

List of NTP servers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(servers)
+

Set NTP servers. This method updates old NTP servers from configuration +and sets the input NTP servers in the configuration. If NTP based time +synchronization is used internally, the NTP daemon will be restarted to +reload given NTP configuration. In case NTP based time synchronization +is not used, this method only replaces servers in the NTP +configuration. This method was added in vSphere API 6.7.

+
+
Parameters
+

servers (list of str) – List of host names or ip addresses of ntp servers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+test(servers)
+

Test the connection to a list of ntp servers. This method was added in +vSphere API 6.7.

+
+
Parameters
+

servers (list of str) – List of host names or IP addresses of NTP servers.

+
+
Return type
+

list of Ntp.TestRunStatus

+
+
Returns
+

List of test run statuses.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Recovery(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Recovery class provides methods to invoke an appliance recovery +(backup and restore). This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(supported=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Recovery.Info class contains the information about the appliance +recovery environment. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

supported (bool) – Is recovery supported in this appliance. This attribute was added +in vSphere API 6.7.

+
+
+
+ +
+
+get()
+

Gets the properties of the appliance Recovery subsystem. This method +was added in vSphere API 6.7.

+
+
Return type
+

Recovery.Info

+
+
Returns
+

Structure containing the properties of the Recovery subsystem.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Service class provides methods to manage a single/set of appliance +services. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(description=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Info class contains information about a service. This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Service description. This attribute was added in vSphere API 6.7.

    • +

  • state (Services.State) – Running State. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Services.State class defines valid Run State for services. This +enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+STARTED = State(string='STARTED')
+

Service Run State is Started, it is fully functional. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+STARTING = State(string='STARTING')
+

Service Run State is Starting, it is still not functional. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+STOPPED = State(string='STOPPED')
+

Service Run State is Stopped. This class attribute was added in vSphere API +6.7.

+
+ +
+
+STOPPING = State(string='STOPPING')
+

Service Run State is Stopping, it is not functional. This class attribute +was added in vSphere API 6.7.

+
+ +
+ +
+
+get(service)
+

Returns the state of a service. This method was added in vSphere API +6.7.

+
+
Parameters
+

service (str) – identifier of the service whose state is being queried. +The parameter must be an identifier for the resource type: +com.vmware.appliance.services.

+
+
Return type
+

Services.Info

+
+
Returns
+

Service Info structure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+list()
+

Lists details of vCenter services. This method was added in vSphere API +6.7.

+
+
Return type
+

dict of str and Services.Info

+
+
Returns
+

Map of service identifiers to service Info structures. +The key in the return value dict will be an identifier for +the resource type: com.vmware.appliance.services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+restart(service)
+

Restarts a service. This method was added in vSphere API 6.7.

+
+
Parameters
+

service (str) – identifier of the service to restart +The parameter must be an identifier for the resource type: +com.vmware.appliance.services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if any timeout occurs during the execution of the restart +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop or start operation is in progress, issuing a restart +operation will lead to this error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a restart operation is issued on a service which has startup +type StartupType#DISABLED

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+start(service)
+

Starts a service. This method was added in vSphere API 6.7.

+
+
Parameters
+

service (str) – identifier of the service to start +The parameter must be an identifier for the resource type: +com.vmware.appliance.services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop or restart operation is in progress, the start operation +will not be allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if start operation is issued on a service which has startup type +StartupType#DISABLED.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if any timeout occurs during the execution of the start operation. +Timeout occurs when the service takes longer than StartTimeout to +start.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+stop(service)
+

Stops a service. This method was added in vSphere API 6.7.

+
+
Parameters
+

service (str) – identifier of the service to stop +The parameter must be an identifier for the resource type: +com.vmware.appliance.services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop operation is in progress, issuing another stop operation +will lead to this error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Shutdown(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Shutdown class provides methods Performs reboot/shutdown operations on +appliance. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ShutdownConfig(shutdown_time=None, action=None, reason=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Shutdown.ShutdownConfig class Structure that defines shutdown +configuration returned by the Shutdown.get operation. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • shutdown_time (datetime.datetime or None) – Shutdown time. This attribute was added in vSphere API 6.7. +shutdownTime Optional value of pending shutdown time

    • +

  • action (str) – The pending shutdown operation. The string values for pending +operations can be ‘poweroff’, ‘reboot’ or ‘’. This attribute was +added in vSphere API 6.7.

    • +

  • reason (str) – The reason behind the shutdown action. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+cancel()
+

Cancel pending shutdown action. This method was added in vSphere API +6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+get()
+

Get details about the pending shutdown action. This method was added in +vSphere API 6.7.

+
+
Return type
+

Shutdown.ShutdownConfig

+
+
Returns
+

Configuration of pending shutdown action.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+poweroff(delay, reason)
+

Power off the appliance. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • delay (long) – Minutes after which poweroff should start. If 0 is specified, +poweroff will start immediately.

    • +

  • reason (str) – Reason for peforming poweroff.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+reboot(delay, reason)
+

Reboot the appliance. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • delay (long) – Minutes after which reboot should start. If 0 is specified, reboot +will start immediately.

    • +

  • reason (str) – Reason for peforming reboot.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.appliance_client.SubtaskInfo(progress=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SubtaskInfo class contains information about one of the subtasks +that makes up an appliance task. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – Progress of the operation. This attribute was added in vSphere API +6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • result (Notifications or None) – Result of the operation. If an operation reports partial results +before it completes, this attribute could be set before +the com.vmware.cis.task_client.CommonInfo.status has the +value com.vmware.cis.task_client.Status.SUCCEEDED. The +value could change as the operation progresses. This attribute was +added in vSphere API 6.7. +This attribute will be None if result is not available at the +current step of the operation.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+class com.vmware.appliance_client.SupportBundle(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SupportBundle class provides methods to create support bundle task, +cancel, list, delete and list components. This class was added in vSphere +API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(description=None, components=None, partition=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Support bundle creation description. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • components ((dict of str and list of str) or None) – Support bundle components to be included. Map with groupName as key +and list of components in that group as the value. This attribute +was added in vSphere API 7.0.1.0.

    • +

  • partition (str or None) – Partition to be used for saving the support bundle. Available +partitions can be retrieved using storage.list API. This attribute +was added in vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class CreationStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CreationStatus instance.

+
+
+
+
+CANCELLED = CreationStatus(string='CANCELLED')
+

Support bundle creation task Cancelled. This class attribute was added in +vSphere API 7.0.1.0.

+
+ +
+
+FAILED = CreationStatus(string='FAILED')
+

Support bundle creation task Failed. This class attribute was added in +vSphere API 7.0.1.0.

+
+ +
+
+SUCCEEDED = CreationStatus(string='SUCCEEDED')
+

Support bundle creation task succeeded. This class attribute was added in +vSphere API 7.0.1.0.

+
+ +
+ +
+
+class FilterSpec(available=None, creation_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • available (bool or None) – Filter only downloadable details. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • creation_status (SupportBundle.CreationStatus or None) – Filter by task status. This attribute was added in vSphere API +7.0.1.0.

    • +
+
+
+
+ +
+
+class Info(description=None, status=None, generation_time=None, url=None, expiration_time=None, downloadable=None, size=None, failure_reason=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Support bundle creation description. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • status (SupportBundle.CreationStatus) – Status of the task. This attribute was added in vSphere API +7.0.1.0.

    • +

  • generation_time (datetime.datetime) – Support bundle generation time. This attribute was added in vSphere +API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of status is SupportBundle.CreationStatus.SUCCEEDED.

    • +

  • url (str) – Support bundle downlooad URL. This attribute was added in vSphere +API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of status is SupportBundle.CreationStatus.SUCCEEDED.

    • +

  • expiration_time (datetime.datetime) – Download expiration time. This attribute was added in vSphere API +7.0.1.0. +This attribute is optional and it is only relevant when the value +of status is SupportBundle.CreationStatus.SUCCEEDED.

    • +

  • downloadable (bool) – Support bundle availability for download. This attribute was added +in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of status is SupportBundle.CreationStatus.SUCCEEDED.

    • +

  • size (long) – Support bundle file size in KBs. This attribute was added in +vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of status is SupportBundle.CreationStatus.SUCCEEDED.

    • +

  • failure_reason (com.vmware.vapi.std_client.LocalizableMessage or None) – Reason for failure. This attribute was added in vSphere API +7.0.1.0. +This attribute is optional and it is only relevant when the value +of status is SupportBundle.CreationStatus.FAILED.

    • +
+
+
+
+ +
+
+class IterationSpec(size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

size (long or None) – Size specifies the maximum number of results to return. This +attribute was added in vSphere API 7.0.1.0. +If None defaults to 50.

+
+
+
+ +
+
+class ListResult(supportbundle_operations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

supportbundle_operations (list of SupportBundle.Info) – Information about all support bundle requests. This attribute was +added in vSphere API 7.0.1.0.

+
+
+
+ +
+
+create_task(spec)
+

Create a support bundle. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+

spec (SupportBundle.CreateSpec) –

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If already a support bundle task is in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+list(iteration=None, filter=None)
+

Get list of support-bundles generated. This method was added in vSphere +API 7.0.1.0.

+
+
Parameters
+
+
+
Return type
+

SupportBundle.ListResult

+
+
Returns
+

List of support bundle details.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.TaskInfo(progress=None, subtask_order=None, subtasks=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TaskInfo class contains information about an appliance task and the +subtasks of which it consists. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – Progress of the task. This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • subtask_order (list of str) – List of tasks that make up this appliance task in the order they +are being run. This attribute was added in vSphere API 6.7.

    • +

  • subtasks (dict of str and SubtaskInfo) – Information about the subtasks that this appliance task consists +of. This attribute was added in vSphere API 6.7.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+class com.vmware.appliance_client.Timesync(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Timesync class provides methods Performs time synchronization +configuration. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class TimeSyncMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Timesync.TimeSyncMode class defines time synchronization modes. +This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the TimeSyncMode instance.

+
+
+
+
+DISABLED = TimeSyncMode(string='DISABLED')
+

Time synchronization is disabled. This class attribute was added in vSphere +API 6.7.

+
+ +
+
+HOST = TimeSyncMode(string='HOST')
+

VMware Tool-based time synchronization. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+NTP = TimeSyncMode(string='NTP')
+

NTP-based time synchronization. This class attribute was added in vSphere +API 6.7.

+
+ +
+ +
+
+get()
+

Get time synchronization mode. This method was added in vSphere API +6.7.

+
+
Return type
+

Timesync.TimeSyncMode

+
+
Returns
+

Time synchronization mode.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+set(mode)
+

Set time synchronization mode. This method was added in vSphere API +6.7.

+
+
Parameters
+

mode (Timesync.TimeSyncMode) – Time synchronization mode.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.appliance_client.Update(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Update class provides methods to get the status of the appliance +update. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(state=None, task=None, version=None, latest_query_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Update.Info class describes the state of the appliance update. This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (Update.State) – State of the appliance update. This attribute was added in vSphere +API 6.7.

    • +

  • task (TaskInfo or None) – The running or completed update task. This attribute was added in +vSphere API 6.7.

    • +

  • version (str) – Version of base appliance if state is UP_TO_DATE Version of update +being staged or installed if state is INSTALL_IN_PROGRESS or +STAGE_IN_PROGRESS Version of update staged if state is +UPDATES_PENDING Version of update failed if state is INSTALL_FAILED +or ROLLBACK_IN_PROGRESS. This attribute was added in vSphere API +6.7.

    • +

  • latest_query_time (datetime.datetime or None) – Timestamp of latest query to update repository. This attribute was +added in vSphere API 6.7. +If None the update was never queried

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Update.State class defines the various states the appliance update +can be in. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+INSTALL_FAILED = State(string='INSTALL_FAILED')
+

The appliance update failed and cannot recover. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+INSTALL_IN_PROGRESS = State(string='INSTALL_IN_PROGRESS')
+

The appliance update is in progress of installing an update. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+ROLLBACK_IN_PROGRESS = State(string='ROLLBACK_IN_PROGRESS')
+

The appliance update failed and recovery is in progress. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+STAGE_IN_PROGRESS = State(string='STAGE_IN_PROGRESS')
+

The appliance update is in progress of downloading an update. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+UPDATES_PENDING = State(string='UPDATES_PENDING')
+

A new update is available. This class attribute was added in vSphere API +6.7.

+
+ +
+
+UP_TO_DATE = State(string='UP_TO_DATE')
+

The appliance is up to date. This class attribute was added in vSphere API +6.7.

+
+ +
+ +
+
+cancel()
+

Request the cancellation the update operation that is currently in +progress. This method was added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +Current task is not cancellable

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
+
+ +
+
+get()
+

Gets the current status of the appliance update. This method was added +in vSphere API 6.7.

+
+
Return type
+

Update.Info

+
+
Returns
+

Info structure containing the status information about the +appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +session is not authenticated

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +session is not authorized to perform this operation

+
+
+
+ +
+ +
+
+

com.vmware.cis_client module

+

The com.vmware.cis_client module provides VMware common infrastructure +classes.

+
+
+class com.vmware.cis_client.Session(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Session class allows API clients to manage session tokens including +creating, deleting and obtaining information about sessions.

+ +

The call to the Session.create() method is part of the overall +authentication process for API clients. For example, the sequence of steps +for establishing a session with SAML token is:

+
    +

  • Connect to lookup service.

    • +

  • Discover the secure token service (STS) endpoint URL.

    • +

  • Connect to the secure token service to obtain a SAML token.

    • +

  • Authenticate to the lookup service using the obtained SAML token.

    • +

  • Discover the API endpoint URL from lookup service.

    • +

  • Call the Session.create() method. The Session.create() call +must include the SAML token.

    • +
+

See the programming guide and samples for additional information about +establishing API sessions.

+

Execution Context and Security Context

+

To use session based authentication a client should supply the session +token obtained through the Session.create() method. The client should +add the session token in the security context when using SDK classes. +Clients using the REST API should supply the session token using the +vmware-api-session-id HTTP header field.

+

Session Lifetime

+

A session begins with call to the Session.create() method to exchange +a SAML token for a API session token. A session ends under the following +circumstances:

+
    +

  • Call to the Session.delete() method.

    • +

  • The session expires. Session expiration may be caused by one of the +following situations:

    • +

  • Client inactivity - For a particular session identified by client +requests that specify the associated session ID, the lapsed time since the +last request exceeds the maximum interval between requests.

    • +

  • Unconditional or absolute session expiration time: At the beginning of +the session, the session logic uses the SAML token and the system +configuration to calculate absolute expiration time.

    • +
+

When a session ends, the authentication logic will reject any subsequent +client requests that specify that session. Any operations in progress will +continue to completion.

+

Error Handling

+

The Session returns the following exceptions:

+ +
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(user=None, created_time=None, last_accessed_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Represents data associated with an API session.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • user (str) – Fully qualified name of the end user that created the session, for +example Administrator\@vsphere.local. A typical use case for +this information is in Graphical User Interfaces (GUI) or logging +systems to visualize the identity of the current user.

    • +

  • created_time (datetime.datetime) – Time when the session was created.

    • +

  • last_accessed_time (datetime.datetime) – Last time this session was used by passing the session token for +invoking an API.

    • +
+
+
+
+ +
+
+create()
+

Creates a session with the API. This is the equivalent of login. This +method exchanges user credentials supplied in the security context for +a session token that is to be used for authenticating subsequent calls.

+

To authenticate subsequent calls clients are expected to include the +session token. For REST API calls the HTTP vmware-api-session-id +header field should be used for this.

+
+
Return type
+

str

+
+
Returns
+

Newly created session token to be used for authenticating further +requests.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the session creation fails due to request specific issues. Due +to the security nature of the API the details of the error are not +disclosed.

+

Please check the following preconditions if using a SAML token to +authenticate:

+
    +

  • the supplied token is delegate-able.

    • +

  • the time of client and server system are synchronized.

    • +

  • the token supplied is valid.

    • +

  • if bearer tokens are used check that system configuration allows +the API endpoint to accept such tokens.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if session creation fails due to server specific issues, for +example connection to a back end component is failing. Due to the +security nature of this API further details will not be disclosed +in the exception. Please refer to component health information, +administrative logs and product specific documentation for possible +causes.

+
+
+
+ +
+
+delete()
+

Terminates the validity of a session token. This is the equivalent of +log out.

+

A session token is expected as part of the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the session id is missing from the request or the corresponding +session object cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if session deletion fails due to server specific issues, for +example connection to a back end component is failing. Due to the +security nature of this API further details will not be disclosed +in the exception. Please refer to component health information, +administrative logs and product specific documentation for possible +causes.

+
+
+
+ +
+
+get()
+

Returns information about the current session. This method expects a +valid session token to be supplied.

+

A side effect of invoking this method may be a change to the session’s +last accessed time to the current time if this is supported by the +session implementation. Invoking any other method in the API will also +update the session’s last accessed time.

+

This API is meant to serve the needs of various front end projects that +may want to display the name of the user. Examples of this include +various web based user interfaces and logging facilities.

+
+
Return type
+

Session.Info

+
+
Returns
+

Information about the session.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the session id is missing from the request or the corresponding +session object cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if session retrieval fails due to server specific issues e.g. +connection to back end component is failing. Due to the security +nature of this API further details will not be disclosed in the +error. Please refer to component health information, administrative +logs and product specific documentation for possible causes.

+
+
+
+ +
+ +
+
+class com.vmware.cis_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.cis_client.Tasks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Tasks class provides methods for managing the task related to a +long running operation. This class was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(tasks=None, services=None, operations=None, status=None, targets=None, users=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tasks.FilterSpec class contains attributes used to filter the +results when listing tasks (see Tasks.list()). If multiple attributes +are specified, only tasks matching all of the attributes match the filter.

+

Currently at least one of Tasks.FilterSpec.tasks or +Tasks.FilterSpec.services must be specified and not empty.. This +class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • tasks (set of str or None) – Identifiers of tasks that can match the filter. This attribute was +added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will contain identifiers for the +resource type: com.vmware.cis.task. +This attribute may be None if services is specified. Currently +all tasks must be from the same provider. If None or empty, tasks +with any identifier will match the filter.

    • +

  • services (set of str or None) – Identifiers of services. Tasks created by operations in these +services match the filter (see +com.vmware.cis.task_client.CommonInfo.service). This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.vapi.service. +This attribute may be None if tasks is specified. Currently all +services must be from the same provider. If this attribute is None +or empty, tasks for any service will match the filter.

    • +

  • operations (set of str or None) –

    Identifiers of operations. Tasks created by these operations match +the filter (see +com.vmware.cis.task_client.CommonInfo.operation).

    +

    Note that an operation identifier by itself is not globally unique. +To filter on an operation, the identifier of the service interface +containing the operation should also be specified in services.. +This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.vapi.operation. +If None or empty, tasks associated with any operation will match +the filter.

    +

    • +

  • status (set of com.vmware.cis.task_client.Status or None) – Status that a task must have to match the filter (see +com.vmware.cis.task_client.CommonInfo.status). This +attribute was added in vSphere API 6.7.1. +If None or empty, tasks with any status match the filter.

    • +

  • targets (list of com.vmware.vapi.std_client.DynamicID or None) – Identifiers of the targets the operation for the associated task +created or was performed on (see +com.vmware.cis.task_client.CommonInfo.target). This +attribute was added in vSphere API 6.7.1. +If None or empty, tasks associated with operations on any target +match the filter.

    • +

  • users (set of str or None) – Users who must have initiated the operation for the associated task +to match the filter (see +com.vmware.cis.task_client.CommonInfo.user). This attribute +was added in vSphere API 6.7.1. +If None or empty, tasks associated with operations initiated by any +user match the filter.

    • +
+
+
+
+ +
+
+class GetSpec(return_all=None, exclude_result=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tasks.GetSpec class describes what data should be included when +retrieving information about a task. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • return_all (bool or None) – If true, all data, including operation-specific data, will be +returned, otherwise only the data described in +com.vmware.cis.task_client.Info will be returned. This +attribute was added in vSphere API 6.7.1. +If None, only the data described in +com.vmware.cis.task_client.Info will be returned.

    • +

  • exclude_result (bool or None) – If true, the result will not be included in the task information, +otherwise it will be included. This attribute was added in vSphere +API 6.7.1. +If None, the result of the operation will be included in the task +information.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.cis.task'
+

Resource type for task. This class attribute was added in vSphere API 6.7.1.

+
+ +
+
+cancel(task)
+

Cancel a running operation associated with the task. This is the best +effort attempt. Operation may not be cancelled anymore once it reaches +certain stage. This method was added in vSphere API 6.7.1.

+
+
Parameters
+

task (str) – Task identifier. +The parameter must be an identifier for the resource type: +com.vmware.cis.task.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the task is already canceled or completed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the task is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the task’s state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the task is not cancelable.

+
+
+
+ +
+
+get(task, spec=None)
+

Returns information about a task. This method was added in vSphere API +6.7.1.

+
+
Parameters
+
    +

  • task (str) – Task identifier. +The parameter must be an identifier for the resource type: +com.vmware.cis.task.

    • +

  • spec (Tasks.GetSpec or None) – Specification on what to get for a task. +If None, the behavior is equivalent to a Tasks.GetSpec +with all attributes None which means only the data described in +com.vmware.cis.task_client.Info will be returned and the +result of the operation will be return.

    • +
+
+
Return type
+

com.vmware.cis.task_client.Info

+
+
Returns
+

Information about the specified task.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the task is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the task’s state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(filter_spec=None, result_spec=None)
+

Returns information about at most 1000 visible (subject to permission +checks) tasks matching the Tasks.FilterSpec. All tasks must be +in the same provider. This method was added in vSphere API 6.7.1.

+
+
Parameters
+
    +

  • filter_spec (Tasks.FilterSpec or None) – Specification of matching tasks. +This is currently required. In the future, if it is None, the +behavior is equivalent to a Tasks.FilterSpec with all +attributes None which means all tasks match the filter.

    • +

  • result_spec (Tasks.GetSpec or None) – Specification of what to return for a task. +If None, the behavior is equivalent to a Tasks.GetSpec +with all attributes None which means only the data describe in +com.vmware.cis.task_client.Info will be returned and the +result of the operation will be return.

    • +
+
+
Return type
+

dict of str and com.vmware.cis.task_client.Info

+
+
Returns
+

Map of task identifier to information about the task. +The key in the return value dict will be an identifier for +the resource type: com.vmware.cis.task.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a task’s state cannot be accessed or over 1000 tasks matching +the Tasks.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+

com.vmware.content_client module

+

The Content module provides classes and classes for configuring global settings +and permissions, and for managing libraries in the Content Library Service.

+
+
+class com.vmware.content_client.Configuration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Configuration class provides methods to configure the global +settings of the Content Library Service.

+

The configuration settings are used by the Content Library Service to +control the behavior of various operations.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Retrieves the current configuration values.

+
+
Return type
+

ConfigurationModel

+
+
Returns
+

The ConfigurationModel instance representing the +configuration of the Content Library Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ContentLibrary.GetConfiguration.

    • +
+
+
+
+ +
+
+update(model)
+

Updates the configuration. The update is incremental. Any attribute in +the ConfigurationModel class that is None will not be +modified. Note that this update method doesn’t guarantee an atomic +change of all the properties. In the case of a system crash or failure, +some of the properties could be left unchanged while others may be +updated.

+
+
Parameters
+

model (ConfigurationModel) – The ConfigurationModel specifying the settings to update.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the configuration properties is not within the proper +range.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ContentLibrary.UpdateConfiguration.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content_client.ConfigurationModel(automatic_sync_enabled=None, automatic_sync_start_hour=None, automatic_sync_stop_hour=None, maximum_concurrent_item_syncs=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConfigurationModel class defines the global settings of the Content +Library Service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • automatic_sync_enabled (bool) –

    Whether automatic synchronization is enabled.

    +

    When automatic synchronization is enabled, the Content Library +Service will automatically synchronize all subscribed libraries on +a daily basis. Subscribed libraries with the +com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled +flag turned on will be synchronized every hour between +ConfigurationModel.automatic_sync_start_hour and +ConfigurationModel.automatic_sync_stop_hour. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    +

    • +

  • automatic_sync_start_hour (long) – The hour at which the automatic synchronization will start. This +value is between 0 (midnight) and 23 inclusive. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +

  • automatic_sync_stop_hour (long) – The hour at which the automatic synchronization will stop. Any +active synchronization operation will continue to run, however no +new synchronization operations will be triggered after the stop +hour. This value is between 0 (midnight) and 23 inclusive. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    • +

  • maximum_concurrent_item_syncs (long) –

    The maximum allowed number of library items to synchronize +concurrently from remote libraries. This must be a positive number. +The service may not be able to guarantee the requested concurrency +if there is no available capacity.

    +

    This setting is global across all subscribed libraries. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    +

    • +
+
+
+
+ +
+
+class com.vmware.content_client.Library(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Library class provides methods to manage and find +LibraryModel entities.

+

The Library class provides support for generic functionality which can +be applied equally to all types of libraries. The functionality provided by +this class will not affect the properties specific to the type of library. +See also LocalLibrary and SubscribedLibrary.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FindSpec(name=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Specifies the properties that can be used as a filter to find libraries. +When multiple attributes are specified, all properties of the library must +match the specification.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Name of the library to search. The name is case-insensitive. See +LibraryModel.name. +If not specified any name will be searched.

    • +

  • type (LibraryModel.LibraryType or None) – Library type to search. See LibraryModel.type. +If not specified any library type will be searched.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.Library'
+

Resource type for library.

+
+ +
+
+find(spec)
+

Returns a list of all the visible (as determined by authorization +policy) libraries matching the requested Library.FindSpec.

+
+
Parameters
+

spec (Library.FindSpec) – Specification describing what properties to filter on.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of all the visible libraries +matching the given spec. +The return value will contain identifiers for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if no properties are specified in the spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+get(library_id)
+

Returns a given LibraryModel.

+
+
Parameters
+

library_id (str) – Identifier of the library to return. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Return type
+

LibraryModel

+
+
Returns
+

The LibraryModel instance with the specified +library_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified library does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns the identifiers of all libraries of any type in the Content +Library.

+
+
Return type
+

list of str

+
+
Returns
+

The list of all identifiers of all libraries in the +Content Library. +The return value will contain identifiers for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+update(library_id, update_spec)
+

Updates the properties of a library.

+

This is an incremental update to the library. Any attribute in the +LibraryModel class that is None will not be modified.

+

This method will only update the common properties for all library +types. This will not, for example, update the +LibraryModel.publish_info of a local library, nor the +LibraryModel.subscription_info of a subscribed library. +Specific properties are updated in LocalLibrary.update() and +SubscribedLibrary.update().

+
+
Parameters
+
    +

  • library_id (str) – Identifier of the library to update. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • update_spec (LibraryModel) – Specification of the new property values to set on the library.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library associated with library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the update_spec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the LibraryModel.version of update_spec is not equal +to the current version of the library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires ContentLibrary.UpdateLibrary.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content_client.LibraryModel(id=None, creation_time=None, description=None, last_modified_time=None, last_sync_time=None, name=None, storage_backings=None, type=None, optimization_info=None, version=None, publish_info=None, subscription_info=None, server_guid=None, security_policy_id=None, unset_security_policy_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryModel class represents a Content Library resource +model.

+

A LibraryModel is a container for a set of items which represent a +usable set of files. The Content Library Service allows for multiple +libraries to be created with separate authorization and sharing policies.

+

Each LibraryModel is a container for a set of +com.vmware.content.library_client.ItemModel instances. Each item +is a logical object in a library, which may have multiple files.

+

A LibraryModel may be local or subscribed. A local library has its +source of truth about items within this Content Library Service. Items may +be added to or removed from the library. A local library may also be +private or published. When published, the library is exposed by a network +endpoint and can be used by another Content Library Service for +synchronization. A private local library cannot be used for +synchronization.

+

A subscribed library is a library which gets its source of truth from +another library that may be across a network in another Content Library +Service. A subscribed library may have a different name and metadata from +the library to which it subscribes, but the set of library items is always +the same as those in the source library. Library items cannot be manually +added to a subscribed library – they can only be added by adding new items +to the source library.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – An identifier which uniquely identifies this LibraryModel. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +This attribute is not used for the create method. It will not +be present in the return value of the get or list methods. +It is not used for the update method.

    • +

  • creation_time (datetime.datetime) – The date and time when this library was created. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • description (str) – A human-readable description for this library. +This attribute is optional for the create method. Leaving it +None during creation will result in an empty string value. It will +always be present in the result of a get or list method. It +is optional for the update method. Leaving it None during +update indicates that the description should be left unchanged.

    • +

  • last_modified_time (datetime.datetime) –

    The date and time when this library was last updated.

    +

    This attribute is updated automatically when the library properties +are changed. This attribute is not affected by adding, removing, or +modifying a library item or its content within the library. Tagging +the library or syncing the subscribed library does not alter this +attribute. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    +

    • +

  • last_sync_time (datetime.datetime) –

    The date and time when this library was last synchronized.

    +

    This attribute applies only to subscribed libraries. It is updated +every time a synchronization is triggered on the library. The value +is None for a local library. +This attribute is not used for the create method. It is +optional in the return value of the get or list methods. It +is not used for the update method.

    +

    • +

  • name (str) –

    The name of the library.

    +

    A Library is identified by a human-readable name. Library names +cannot be undefined or an empty string. Names do not have to be +unique. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is optional for the update method.

    +

    • +

  • storage_backings (list of com.vmware.content.library_client.StorageBacking) –

    The list of default storage backings which are available for this +library.

    +

    A com.vmware.content.library_client.StorageBacking defines +a default storage location which can be used to store files for +library items in this library. Some library items, for instance, +virtual machine template items, support files that may be +distributed across various storage backings. One or more item files +may or may not be located on the default storage backing.

    +

    Multiple default storage locations are not currently supported but +may become supported in future releases. +This attribute must be provided for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    +

    • +

  • type (LibraryModel.LibraryType) –

    The type (LOCAL, SUBSCRIBED) of this library.

    +

    This value can be used to determine what additional services and +information can be available for this library. This attribute is +not used for the create and update methods. It will always +be present in the result of a get method. +This attribute is not used for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    +

    • +

  • optimization_info (com.vmware.content.library_client.OptimizationInfo) – Defines various optimizations and optimization parameters applied +to this library. +This attribute is optional for the create method. It is +optional in the return value of the get or list methods. It +is optional for the update method.

    • +

  • version (str) –

    A version number which is updated on metadata changes. This value +allows clients to detect concurrent updates and prevent accidental +clobbering of data.

    +

    This value represents a number which is incremented every time +library properties, such as name or description, are changed. It is +not incremented by changes to a library item within the library, +including adding or removing items. It is also not affected by +tagging the library. +This attribute is not used for the create method. It will +always be present in the result of a get or list method. It +is optional for the update method. Leaving it None during +update indicates that you do not need to detect concurrent updates.

    +

    • +

  • publish_info (com.vmware.content.library_client.PublishInfo) –

    Defines how this library is published so that it can be subscribed +to by a remote subscribed library.

    +

    The com.vmware.content.library_client.PublishInfo defines +where and how the metadata for this local library is accessible. A +local library is only published publically if +com.vmware.content.library_client.PublishInfo.published is +true. +This attribute is optional for the create and update +methods. If not specified during creation, the default is for the +library to not be published. If not specified during update, the +attribute is left unchanged.

    +

    • +

  • subscription_info (com.vmware.content.library_client.SubscriptionInfo) –

    Defines the subscription behavior for this Library.

    +

    The com.vmware.content.library_client.SubscriptionInfo +defines how this subscribed library synchronizes to a remote +source. Setting the value will determine the remote source to which +the library synchronizes, and how. Changing the subscription will +result in synchronizing to a new source. If the new source differs +from the old one, the old library items and data will be lost. +Setting +com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled +to false will halt subscription but will not remove existing cached +data. +This attribute is optional for the create and update +methods. If not specified during creation, a default will be +created without an active subscription. If not specified during +update, the attribute is left unchanged.

    +

    • +

  • server_guid (str) – The unique identifier of the vCenter server where the library +exists. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.VCenter. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vcenter.VCenter. +This attribute is optional for the create method. It will +always be present in the return value of the get or list +methods. It is not used for the update method.

    • +

  • security_policy_id (str or None) –

    Represents the security policy applied to this library.

    +

    Setting the attribute will make the library secure. This field is +ignored in update method if +LibraryModel.unset_security_policy_id is set to true.. +This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +This attribute is optional for the create and update +methods. If not set in create method, the library will be +insecure. If not specified in update method, the attribute is +left unchanged.

    +

    • +

  • unset_security_policy_id (bool) –

    This represents the intent of the change to +LibraryModel.security_policy_id in update method.

    +

    If this field is set to true, any security policy applied to +the library will be removed. If this field is set to false, any +security policy applied to library will be changed to the value +specified in LibraryModel.security_policy_id, if any.. This +attribute was added in vSphere API 7.0.3.0. +This attribute is optional for the update method. If None, any +existing security policy will be changed to the value specified in +LibraryModel.security_policy_id, if any.

    +

    • +
+
+
+
+
+class LibraryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LibraryModel.LibraryType class defines the type of a +LibraryModel.

+

The type of a library can be used to determine which additional services +can be performed with a library.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LibraryType instance.

+
+
+
+
+LOCAL = LibraryType(string='LOCAL')
+

The library contents are defined and stored by the local Content Library +Service installation.

+

A local library can be retrieved and managed via the LocalLibrary.

+
+ +
+
+SUBSCRIBED = LibraryType(string='SUBSCRIBED')
+

The library synchronizes its items and content from another published +library.

+

A subscribed library can be retrieved and managed via the +SubscribedLibrary.

+
+ +
+ +
+ +
+
+class com.vmware.content_client.LocalLibrary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LocalLibrary class manages local libraries.

+

The LocalLibrary class provides support for creating and maintaining +local library instances. A local library may also use the Library +class to manage general library functionality.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DestinationSpec(subscription=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalLibrary.DestinationSpec class contains information required to +publish the library to a specific subscription. This class was added in +vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

subscription (str) – Identifier of the subscription associated with the subscribed +library. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Subscriptions. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.Subscriptions.

+
+
+
+ +
+
+create(create_spec, client_token=None)
+

Creates a new local library.

+
+
Parameters
+
    +

  • client_token (str or None) – A unique token generated on the client for each creation request. +The token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified creation is not idempotent.

    • +

  • create_spec (LibraryModel) – Specification for the new local library.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly created LibraryModel. +The return value will be an identifier for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the create_spec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the client_token does not conform to the UUID format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if using multiple storage backings.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ContentLibrary.CreateLocalLibrary.

    • +

  • The resource Datastore referenced by the attribute +com.vmware.content.library_client.StorageBacking.datastore_id +requires Datastore.AllocateSpace.

    • +
+
+
+
+ +
+
+delete(library_id)
+

Deletes the specified local library.

+

Deleting a local library will remove the entry immediately and begin an +asynchronous task to remove all cached content for the library. If the +asynchronous task fails, file content may remain on the storage +backing. This content will require manual removal.

+
+
Parameters
+

library_id (str) – Identifier of the local library to delete. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library specified by library_id is not a local library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the library contains a library item that cannot be deleted in +its current state. For example, the library item contains a virtual +machine template and a virtual machine is checked out of the +library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires +ContentLibrary.DeleteLocalLibrary.

    • +
+
+
+
+ +
+
+get(library_id)
+

Returns a given local library.

+
+
Parameters
+

library_id (str) – Identifier of the local library to return. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Return type
+

LibraryModel

+
+
Returns
+

The LibraryModel instance associated with library_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library specified by library_id is not a local library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns the identifiers of all local libraries in the Content Library.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of all local libraries in the +Content Library. +The return value will contain identifiers for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+publish(library_id, subscriptions=None)
+

Publishes the library to specified subscriptions. If no subscriptions +are specified, then publishes the library to all its subscriptions. +This method was added in vSphere API 6.7.2.

+
+
Parameters
+
    +

  • library_id (str) – Identifier of the published library. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • subscriptions (list of LocalLibrary.DestinationSpec or None) – The list of subscriptions to publish this library to.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If one or more subscriptions is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +If the library specified by library_id is a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the library specified by library_id is not a published +library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires +ContentLibrary.PublishLibrary.

    • +
+
+
+
+ +
+
+update(library_id, update_spec)
+

Updates the properties of a local library.

+

This is an incremental update to the local library. Attributes that are +None in the update specification will be left unchanged.

+
+
Parameters
+
    +

  • library_id (str) – Identifier of the local library to update. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • update_spec (LibraryModel) – Specification of the new property values to set on the local +library.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the library specified by library_id is a published library +with JSON persistence enabled (see +com.vmware.content.library_client.PublishInfo.persist_json_enabled) +and the content of the library has been deleted from the storage +backings (see LibraryModel.storage_backings) associated +with it.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library specified by library_id is not a local library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the update_spec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the +com.vmware.content.library_client.PublishInfo.current_password +in the update_spec does not match the existing password of the +published library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the LibraryModel.version of update_spec is None and +the library is being concurrently updated by another user.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ConcurrentChange +if the LibraryModel.version of update_spec is not equal +to the current version of the library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires +ContentLibrary.UpdateLocalLibrary.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content_client.SecurityPolicies(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SecurityPolicies class provides methods to manage security +policies. A policy can be applied to a content library. This class was +added in vSphere API 7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(policy=None, name=None, item_type_rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Representation of a security policy. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Identifier of the security policy. This attribute was added in +vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.SecurityPolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.SecurityPolicy.

    • +

  • name (str) – Name of the security policy. This attribute was added in vSphere +API 7.0.3.0.

    • +

  • item_type_rules (dict of str and SecurityRuleType) – Map of content library item type and rule types The rules can be +associated with a security policy. When the security policy is +applied to a content library, these rules will be used to validate +specific item type. This attribute was added in vSphere API +7.0.3.0.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.SecurityPolicy'
+

Resource type for security policies. This class attribute was added in vSphere +API 7.0.3.0.

+
+ +
+
+list()
+

Returns the list of security policies. This method was added in vSphere +API 7.0.3.0.

+
+
Return type
+

list of SecurityPolicies.Info

+
+
Returns
+

List of security policies.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content_client.SecurityRuleType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SecurityRuleType class defines the security rules which can be +applied to different item types. This enumeration was added in vSphere API +7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SecurityRuleType instance.

+
+
+
+
+OVF_STRICT_VERIFICATION = SecurityRuleType(string='OVF_STRICT_VERIFICATION')
+

This rule indicates that an OVF/OVA item can only be imported or synced to +a content library if its certificate is valid and signed by a trusted CA. +This class attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class com.vmware.content_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.content_client.SubscribedLibrary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ProbeResult(status=None, ssl_thumbprint=None, error_messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SubscribedLibrary.ProbeResult class defines the subscription +information probe result. This describes whether using a given subscription +URL is successful or if there are access problems, such as SSL errors.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (SubscribedLibrary.ProbeResult.Status) – The status of probe result. This will be one of SUCCESS, +INVALID_URL, TIMED_OUT, HOST_NOT_FOUND, RESOURCE_NOT_FOUND, +INVALID_CREDENTIALS, CERTIFICATE_ERROR, UNKNOWN_ERROR.

    • +

  • ssl_thumbprint (str or None) – The SSL thumbprint for the remote endpoint. +A SSL thumbprint is only returned if the host is secured with +SSL/TLS.

    • +

  • error_messages (list of com.vmware.vapi.std_client.LocalizableMessage) – If the probe result is in an error status, this attribute will +contain the detailed error messages.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SubscribedLibrary.ProbeResult.Status class defines the error status +constants for the probe result.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+CERTIFICATE_ERROR = Status(string='CERTIFICATE_ERROR')
+

Indicates that the provided server certificate in +com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint +is invalid. In this case, the returned #sslThumbprint should be set in +com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint.

+
+ +
+
+HOST_NOT_FOUND = Status(string='HOST_NOT_FOUND')
+

Indicates that the host in the URL could not be found.

+
+ +
+
+INVALID_CREDENTIALS = Status(string='INVALID_CREDENTIALS')
+

Indicates that the connection was rejected due to invalid credentials.

+
+ +
+
+INVALID_URL = Status(string='INVALID_URL')
+

Indicates that the supplied URL was not valid.

+
+ +
+
+RESOURCE_NOT_FOUND = Status(string='RESOURCE_NOT_FOUND')
+

Indicates that the given resource at the URL was not found.

+
+ +
+
+SUCCESS = Status(string='SUCCESS')
+

Indicates that the probe was successful.

+
+ +
+
+TIMED_OUT = Status(string='TIMED_OUT')
+

Indicates that the probe timed out while attempting to connect to the URL.

+
+ +
+
+UNKNOWN_ERROR = Status(string='UNKNOWN_ERROR')
+

Indicates an unspecified error different from the other error cases defined +in SubscribedLibrary.ProbeResult.Status.

+
+ +
+ +
+ +
+
+create(create_spec, client_token=None)
+

Creates a new subscribed library.

+

Once created, the subscribed library will be empty. If the +LibraryModel.subscription_info property is set, the Content +Library Service will attempt to synchronize to the remote source. This +is an asynchronous operation so the content of the published library +may not immediately appear.

+
+
Parameters
+
    +

  • client_token (str or None) – Unique token generated on the client for each creation request. The +token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified creation is not idempotent.

    • +

  • create_spec (LibraryModel) – Specification for the new subscribed library.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly created subscribed library. +The return value will be an identifier for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the create_spec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the client_token does not conform to the UUID format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if using multiple storage backings.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if subscribing to a published library which cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +ContentLibrary.CreateSubscribedLibrary.

    • +

  • The resource Datastore referenced by the attribute +com.vmware.content.library_client.StorageBacking.datastore_id +requires Datastore.AllocateSpace.

    • +
+
+
+
+ +
+
+delete(library_id)
+

Deletes the specified subscribed library.

+

Deleting a subscribed library will remove the entry immediately and +begin an asynchronous task to remove all cached content for the +library. If the asynchronous task fails, file content may remain on the +storage backing. This content will require manual removal.

+
+
Parameters
+

library_id (str) – Identifier of the subscribed library to delete. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library referenced by library_id is not a subscribed +library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library referenced by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires +ContentLibrary.DeleteSubscribedLibrary.

    • +
+
+
+
+ +
+
+evict(library_id)
+

Evicts the cached content of an on-demand subscribed library.

+

This method allows the cached content of a subscribed library to be +removed to free up storage capacity. This method will only work when a +subscribed library is synchronized on-demand.

+
+
Parameters
+

library_id (str) – Identifier of the subscribed library whose content should be +evicted. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library specified by library_id is not a subscribed +library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the library specified by library_id does not synchronize +on-demand, or if the content of the library specified by +library_id has been deleted from the storage backings (see +LibraryModel.storage_backings) associated with it.

+

For instance, this {\@term error) is reported on evicting an +on-demand subscribed library that was restored from backup, and the +library was deleted after the backup was taken, thus resulting in +its content being deleted from the associated storage backings. In +this scenario, the metadata of the library is present on a restore, +while its content has been deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires +ContentLibrary.EvictSubscribedLibrary.

    • +
+
+
+
+ +
+
+get(library_id)
+

Returns a given subscribed library.

+
+
Parameters
+

library_id (str) – Identifier of the subscribed library to return. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Return type
+

LibraryModel

+
+
Returns
+

The LibraryModel instance that corresponds to +library_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library associated with library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library associated with library_id is not a subscribed +library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns the identifiers of all subscribed libraries in the Content +Library.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers of all subscribed libraries in the +Content Library. +The return value will contain identifiers for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+probe(subscription_info)
+

Probes remote library subscription information, including URL, SSL +certificate and password. The resulting +SubscribedLibrary.ProbeResult class describes whether or not +the subscription configuration is successful.

+
+
Parameters
+

subscription_info (com.vmware.content.library_client.SubscriptionInfo) – The subscription info to be probed.

+
+
Return type
+

SubscribedLibrary.ProbeResult

+
+
Returns
+

The subscription info probe result.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ContentLibrary.ProbeSubscription.

    • +
+
+
+
+ +
+
+sync(library_id)
+

Forces the synchronization of the subscribed library.

+

Synchronizing a subscribed library forcefully with this method will +perform the same synchronization behavior as would run periodically for +the library. The +com.vmware.content.library_client.SubscriptionInfo.on_demand +setting is respected. Calling this method on a library that is already +in the process of synchronizing will have no effect.

+
+
Parameters
+

library_id (str) – Identifier of the subscribed library to synchronize. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library specified by library_id is not a subscribed +library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the content of the library specified by library_id has been +deleted from the storage backings (see +LibraryModel.storage_backings) associated with it.

+

For instance, this {\@term error) is reported on synchronizing a +subscribed library that was restored from backup, and the library +was deleted after the backup was taken, thus resulting in its +content being deleted from the associated storage backings. In this +scenario, the metadata of the library is present on a restore, +while its content has been deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if some parameter in the subscribed library subscription info is +invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the published library cannot be contacted or found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires ContentLibrary.SyncLibrary.

    • +
+
+
+
+ +
+
+update(library_id, update_spec)
+

Updates the properties of a subscribed library.

+

This is an incremental update to the subscribed library. Attributes +that are None in the update specification will be left unchanged.

+
+
Parameters
+
    +

  • library_id (str) – Identifier of the subscribed library to update. +The parameter must be an identifier for the resource type: +com.vmware.content.Library.

    • +

  • update_spec (LibraryModel) – Specification of the new property values to set on the subscribed +library.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by library_id does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the update_spec updates the subscription URL (see +com.vmware.content.library_client.SubscriptionInfo.subscription_url) +and the content of the library specified by library_id has been +deleted from the storage backings (see +LibraryModel.storage_backings) associated with it.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the library specified by library_id is not a subscribed +library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the update_spec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the subscription info is being updated but the published library +cannot be contacted or found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the LibraryModel.version of update_spec is None and +the library is being concurrently updated by another user.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ConcurrentChange +if the LibraryModel.version of update_spec is not equal +to the current version of the library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.Library referenced by the +parameter library_id requires +ContentLibrary.UpdateSubscribedLibrary.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content_client.TrustedCertificates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TrustedCertificates class provides methods to create, modify, +delete and read trusted certificates. This class was added in vSphere API +7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(cert_text=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedCertificates.CreateSpec class is the specification used to +create a trusted certificate, see TrustedCertificates.create(). This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

cert_text (str) – A certText is the certificate in Base64 encoded PEM format. The +input must be a single line string with escape sequence for +new-lines. This attribute was added in vSphere API 7.0.3.0.

+
+
+
+ +
+
+class Info(cert_text=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedCertificates.Info class contains a trusted certificate. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

cert_text (str) – A certificate in Base64 encoding. This attribute was added in +vSphere API 7.0.3.0.

+
+
+
+ +
+
+class ListResult(certificates=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedCertificates.ListResult class contains list of Summary of +the trusted certificates, see TrustedCertificates.list(). This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

certificates (list of TrustedCertificates.Summary) – List of certificates. This attribute was added in vSphere API +7.0.3.0.

+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.TrustedCertificate'
+

Resource type for trusted certificates. This class attribute was added in +vSphere API 7.0.3.0.

+
+ +
+
+class Summary(certificate=None, cert_text=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedCertificates.Summary class contains a trusted certificate +summary. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • certificate (str) – Unique identifier for the certificate. It is the TrustStore alias +of the certificate. The alias is the SHA256 hash of the raw +certificate data. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.TrustedCertificate. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.TrustedCertificate.

    • +

  • cert_text (str) – Certificate in Base64 encoded PEM format.. This attribute was added +in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+create(spec)
+

Adds a certificate to content library trust store.

+

This API has to be invoked separately for each certificate block - +(BEGIN_CERTIFICATE … END_CERTIFICATE). This method was added in +vSphere API 7.0.3.0.

+
+
Parameters
+

spec (TrustedCertificates.CreateSpec) – Specification for the certificate to be added to content library +trust store.

+
+
Return type
+

str

+
+
Returns
+

ID of the certificates added. The certificate ID will be unique for +each certificate. If the certificate already exists, existing ID is +returned. +The return value will be an identifier for the resource type: +com.vmware.content.TrustedCertificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ContentLibrary.AddCertToTrustStore.

    • +
+
+
+
+ +
+
+delete(certificate)
+

Deletes the trusted certificate from content library’s trust store for +a given identifier. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

certificate (str) – id of the trusted certificate. +The parameter must be an identifier for the resource type: +com.vmware.content.TrustedCertificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the trusted certificate specified by certificate could not +be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.TrustedCertificate referenced +by the parameter certificate requires +ContentLibrary.DeleteCertFromTrustStore.

    • +
+
+
+
+ +
+
+get(certificate)
+

Retrieves a trusted certificate for a given certificate id. This method +was added in vSphere API 7.0.3.0.

+
+
Parameters
+

certificate (str) – id of the trusted certificate. +The parameter must be an identifier for the resource type: +com.vmware.content.TrustedCertificate.

+
+
Return type
+

TrustedCertificates.Info

+
+
Returns
+

TrustedCertificates.Info instance that corresponds to the +certificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a trusted certificate does not exist for given id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.content.TrustedCertificate referenced +by the parameter certificate requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns TrustedCertificates.ListResult class. All content library’s +trusted certificates. This method was added in vSphere API 7.0.3.0.

+
+
Return type
+

TrustedCertificates.ListResult

+
+
Returns
+

TrustedCertificates.ListResult containing trusted certificates.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.content_client.Type(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Type class exposes the +com.vmware.content.library_client.ItemModel types that this +Content Library Service supports.

+

A library item has an optional type which can be specified with the +com.vmware.content.library_client.ItemModel.type attribute. For +items with a type that is supported by a plugin, the Content Library +Service may understand the files which are part of the library item and can +produce metadata for the item.

+

In other cases, uploads may require a process in which one upload implies +subsequent uploads. For example, an Open Virtualization Format (OVF) +package is composed of an OVF descriptor file and the associated virtual +disk files. Uploading an OVF descriptor can enable the Content Library +Service to understand that the complete OVF package requires additional +disk files, and it can set up the transfers for the disks automatically by +adding the file entries for the disks when the OVF descriptor is uploaded.

+

When a type is not supported by a plugin, or the type is not specified, the +Content Library Service can handle a library item in a default way, without +adding metadata to the item or guiding the upload process.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(description=None, name=None, type=None, vendor=None, version=None, supported_rules=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Type.Info class describes support for a specific type of data in an +com.vmware.content.library_client.ItemModel. The Type.Info can +be queried through the Type class. Type support describes plugins +in the Content Library which can provide metadata on library items and help +manage the transfer process by adding dependent files when a current file +is added.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – A description of the type support offered by the plugin.

    • +

  • name (str) – The name of the plugin which provides the type support.

    • +

  • type (str) –

    The type which the plugin supports.

    +

    To upload a library item of the type supported by the plugin, the +com.vmware.content.library_client.ItemModel.type attribute +of the item should be set to this value.

    +

    • +

  • vendor (str) – The name of the vendor who created the type support plugin.

    • +

  • version (str) – The version number of the type support plugin.

    • +

  • supported_rules (list of SecurityRuleType or None) – List of security rules which can be applied to this item type. This +attribute was added in vSphere API 7.0.3.0. +If None no security rule can be associated with this item type.

    • +
+
+
+
+ +
+
+list()
+

Returns a list of Type.Info instances which describe +the type support plugins in a Content Library.

+
+
Return type
+

list of Type.Info

+
+
Returns
+

The list of Type.Info instances which describe +the type support plugins in a Content Library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ContentLibrary.TypeIntrospection.

    • +
+
+
+
+ +
+ +
+
+

com.vmware.oauth2_client module

+

The com.vmware.oauth2_client module contains classes for reuse by OAuth2 +API definitions.

+
+
+class com.vmware.oauth2_client.Constants
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Constants defined in RFC 6749 and RFC 8693.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
+ACCESS_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:access_token'
+

Token type URI for an OAuth 2.0 access token

+
+ +
+
+ID_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:id_token'
+

Token type URI for an ID Token

+
+ +
+
+REFRESH_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:refresh_token'
+

Token type URI for an OAuth 2.0 refresh token

+
+ +
+
+SAML2_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:saml2'
+

Token type URI for a base64url-encoded SAML 2.0

+
+ +
+
+TOKEN_EXCHANGE_GRANT = 'urn:ietf:params:oauth:grant-type:token-exchange'
+

Token exchange grant type for OAuth 2.0

+
+ +
+ +
+
+class com.vmware.oauth2_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.oauth2_client.TokenInfo(access_token=None, token_type=None, expires_in=None, scope=None, refresh_token=None, issued_token_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TokenInfo class contains data that represents successful +access-token response as defined in RFC 6749 and extended in RFC 8693.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • access_token (str) – The access token issued by the authorization server.

    • +

  • token_type (str) – A case-insensitive value specifying the method of using the access +token issued.

    • +

  • expires_in (long or None) – The validity lifetime, in seconds, of the token issued by the +server. +None if not applicable for issued token.

    • +

  • scope (str or None) – Scope of the issued access token. The value of the scope parameter +is expressed as a list of space- delimited, case-sensitive strings. +The strings are defined by the authorization server. If the value +contains multiple space-delimited strings, their order does not +matter, and each string adds an additional access range to the +requested scope. +None if the scope of the issued security token is identical to the +scope requested by the client.

    • +

  • refresh_token (str or None) – The refresh token, which can be used to obtain new access tokens. +None if not applicable to the specific request.

    • +

  • issued_token_type (str or None) – An identifier which indicates the type of the access token in the +TokenInfo.access_token attribute. +None if not the result of a token-exchange invocation; otherwise, +required.

    • +
+
+
+
+
+BEARER_TOKEN_METHOD_TYPE = 'Bearer'
+

Class attribute indicating that the security token is a bearer token.

+
+ +
+ +
+
+

com.vmware.vapi_client module

+

The com.vmware.vapi_client component provides API infrastructure classes +and standard types that can be used in the interface specification of any +class.

+
+
+class com.vmware.vapi_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter_client module

+

The com.vmware.vcenter_client module provides classes for managing VMware +vSphere environments. The module is available starting in vSphere 6.5.

+
+
+class com.vmware.vcenter_client.Cluster(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Cluster class provides methods to manage clusters in the vCenter +Server.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(clusters=None, names=None, folders=None, datacenters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.FilterSpec class contains attributes used to filter the +results when listing clusters (see Cluster.list()). If multiple +attributes are specified, only clusters matching all of the attributes +match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • clusters (set of str or None) – Identifiers of clusters that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None or empty, clusters with any identifier match the filter.

    • +

  • names (set of str or None) – Names that clusters must have to match the filter (see +Cluster.Info.name). +If None or empty, clusters with any name match the filter.

    • +

  • folders (set of str or None) – Folders that must contain the cluster for the cluster to match the +filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, clusters in any folder match the filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the cluster for the cluster to match +the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, clusters in any datacenter match the filter.

    • +
+
+
+
+ +
+
+class Info(name=None, resource_pool=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.Info class contains information about a cluster in vCenter +Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the cluster

    • +

  • resource_pool (str) – Identifier of the root resource pool of the cluster +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'ClusterComputeResource'
+

The resource type for the vCenter Cluster

+
+ +
+
+class Summary(cluster=None, name=None, ha_enabled=None, drs_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.Summary class contains commonly used information about a +cluster in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • name (str) – Name of the cluster.

    • +

  • ha_enabled (bool) – Flag indicating whether the vSphere HA feature is enabled for the +cluster.

    • +

  • drs_enabled (bool) – Flag indicating whether the vSphere DRS service is enabled for the +cluster.

    • +
+
+
+
+ +
+
+get(cluster)
+

Retrieves information about the cluster corresponding to cluster.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Cluster.Info

+
+
Returns
+

Information about the cluster associated with cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no cluster associated with cluster in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the session id is missing from the request or the corresponding +session object cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t not have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires System.Read.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 1000 visible (subject to permission +checks) clusters in vCenter matching the Cluster.FilterSpec.

+
+
Parameters
+

filter (Cluster.FilterSpec or None) – Specification of matching clusters for which information should be +returned. +If None, the behavior is equivalent to a +Cluster.FilterSpec with all attributes None which means +all clusters match the filter.

+
+
Return type
+

list of Cluster.Summary

+
+
Returns
+

Commonly used information about the clusters matching the +Cluster.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1000 clusters match the Cluster.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.Datacenter(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Datacenter class provides methods to manage datacenters in the +vCenter Server.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, folder=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datacenter.CreateSpec class defines the information used to create +a datacenter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the datacenter to be created.

    • +

  • folder (str or None) – Datacenter folder in which the new datacenter should be created. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose a suitable +folder for the datacenter; if a folder cannot be chosen, the +datacenter creation operation will fail.

    • +
+
+
+
+ +
+
+class FilterSpec(datacenters=None, names=None, folders=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datacenter.FilterSpec class contains attributes used to filter the +results when listing datacenters (see Datacenter.list()). If multiple +attributes are specified, only datacenters matching all of the attributes +match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datacenters (set of str or None) – Identifiers of datacenters that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, datacenters with any identifier match the filter.

    • +

  • names (set of str or None) – Names that datacenters must have to match the filter (see +Datacenter.Info.name). +If None or empty, datacenters with any name match the filter.

    • +

  • folders (set of str or None) – Folders that must contain the datacenters for the datacenter to +match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, datacenters in any folder match the filter.

    • +
+
+
+
+ +
+
+class Info(name=None, datastore_folder=None, host_folder=None, network_folder=None, vm_folder=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datacenter.Info class contains information about a datacenter in +vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the datacenter.

    • +

  • datastore_folder (str) – The root datastore folder associated with the datacenter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder.

    • +

  • host_folder (str) – The root host and cluster folder associated with the datacenter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder.

    • +

  • network_folder (str) – The root network folder associated with the datacenter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder.

    • +

  • vm_folder (str) – The root virtual machine folder associated with the datacenter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'Datacenter'
+

The resource type for the vCenter Datacenter

+
+ +
+
+class Summary(datacenter=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datacenter.Summary class contains commonly used information about a +datacenter in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datacenter (str) – Identifier of the datacenter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datacenter.

    • +

  • name (str) – Name of the datacenter.

    • +
+
+
+
+ +
+
+create(spec)
+

Create a new datacenter in the vCenter inventory

+
+
Parameters
+

spec (Datacenter.CreateSpec) – Specification for the new datacenter to be created.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the newly created datacenter +The return value will be an identifier for the resource type: +Datacenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a datacenter with the same name is already present.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the datacenter name is empty or invalid as per the underlying +implementation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the folder is not specified and the system cannot choose a +suitable one.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the datacenter folder cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+delete(datacenter, force=None)
+

Delete an empty datacenter from the vCenter Server

+
+
Parameters
+
    +

  • datacenter (str) – Identifier of the datacenter to be deleted. +The parameter must be an identifier for the resource type: +Datacenter.

    • +

  • force (bool or None) – If true, delete the datacenter even if it is not empty. +If None a com.vmware.vapi.std.errors_client.ResourceInUse +exception will be reported if the datacenter is not empty. This is +the equivalent of passing the value false.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no datacenter associated with datacenter in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the datacenter associated with datacenter is not empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(datacenter)
+

Retrieves information about the datacenter corresponding to +datacenter.

+
+
Parameters
+

datacenter (str) – Identifier of the datacenter. +The parameter must be an identifier for the resource type: +Datacenter.

+
+
Return type
+

Datacenter.Info

+
+
Returns
+

Information about the datacenter associated with datacenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no datacenter associated with datacenter in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 1000 visible (subject to permission +checks) datacenters in vCenter matching the +Datacenter.FilterSpec.

+
+
Parameters
+

filter (Datacenter.FilterSpec or None) – Specification of matching datacenters for which information should +be returned. +If None, the behavior is equivalent to a +Datacenter.FilterSpec with all attributes None which means +all datacenters match the filter.

+
+
Return type
+

list of Datacenter.Summary

+
+
Returns
+

Commonly used information about the datacenters matching the +Datacenter.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1000 datacenters match the +Datacenter.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.Datastore(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Datastore class provides methods for manipulating a datastore.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(datastores=None, names=None, types=None, folders=None, datacenters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datastore.FilterSpec class contains attributes used to filter the +results when listing datastores (see Datastore.list()). If multiple +attributes are specified, only datastores matching all of the attributes +match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastores (set of str or None) – Identifiers of datastores that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datastore. +If None or empty, datastores with any identifier match the filter.

    • +

  • names (set of str or None) – Names that datastores must have to match the filter (see +Datastore.Info.name). +If None or empty, datastores with any name match the filter.

    • +

  • types (set of Datastore.Type or None) – Types that datastores must have to match the filter (see +Datastore.Summary.type). +If None or empty, datastores with any type match the filter.

    • +

  • folders (set of str or None) – Folders that must contain the datastore for the datastore to match +the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, datastores in any folder match the filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the datastore for the datastore to +match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, datastores in any datacenter match the filter.

    • +
+
+
+
+ +
+
+class Info(name=None, type=None, accessible=None, free_space=None, multiple_host_access=None, thin_provisioning_supported=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datastore.Info class contains information about a datastore.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the datastore.

    • +

  • type (Datastore.Type) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datastore.

    • +

  • accessible (bool) – Whether or not this datastore is accessible.

    • +

  • free_space (long or None) –

    Available space of this datastore, in bytes.

    +

    The server periodically updates this value. +This attribute will be None if the available space of this +datastore is not known.

    +

    • +

  • multiple_host_access (bool) – Whether or not more than one host in the datacenter has been +configured with access to the datastore.

    • +

  • thin_provisioning_supported (bool) – Whether or not the datastore supports thin provisioning on a per +file basis. When thin provisioning is used, backing storage is +lazily allocated.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'Datastore'
+

The resource type for the vCenter datastore

+
+ +
+
+class Summary(datastore=None, name=None, type=None, free_space=None, capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datastore.Summary class contains commonly used information about a +datastore.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str) – Identifier of the datastore. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore.

    • +

  • name (str) – Name of the datastore.

    • +

  • type (Datastore.Type) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datatore.

    • +

  • free_space (long or None) –

    Available space of this datastore, in bytes.

    +

    The server periodically updates this value. +This attribute will be None if the available space of this +datastore is not known.

    +

    • +

  • capacity (long or None) –

    Capacity of this datastore, in bytes.

    +

    The server periodically updates this value. +This attribute will be None if the capacity of this datastore is +not known.

    +

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Datastore.Type class defines the supported types of vCenter +datastores.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+CIFS = Type(string='CIFS')
+

Common Internet File System.

+
+ +
+
+NFS = Type(string='NFS')
+

Network file system v3 (linux & esx servers only).

+
+ +
+
+NFS41 = Type(string='NFS41')
+

Network file system v4.1 (linux & esx servers only).

+
+ +
+
+VFFS = Type(string='VFFS')
+

Flash Read Cache (ESX Server only).

+
+ +
+
+VMFS = Type(string='VMFS')
+

VMware File System (ESX Server only).

+
+ +
+
+VSAN = Type(string='VSAN')
+

Virtual SAN (ESX Server only).

+
+ +
+
+VVOL = Type(string='VVOL')
+

vSphere Virtual Volume (ESX Server only).

+
+ +
+ +
+
+get(datastore)
+

Retrieves information about the datastore indicated by datastore.

+
+
Parameters
+

datastore (str) – Identifier of the datastore for which information should be +retrieved. +The parameter must be an identifier for the resource type: +Datastore.

+
+
Return type
+

Datastore.Info

+
+
Returns
+

Information about the datastore associated with datastore.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the datastore indicated by datastore does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 2500 visible (subject to permission +checks) datastores in vCenter matching the +Datastore.FilterSpec.

+
+
Parameters
+

filter (Datastore.FilterSpec or None) – Specification of matching datastores for which information should +be returned. +If None, the behavior is equivalent to a +Datastore.FilterSpec with all attributes None which means +all datastores match the filter.

+
+
Return type
+

list of Datastore.Summary

+
+
Returns
+

Commonly used information about the datastores matching the +Datastore.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Datastore.FilterSpec.types attribute contains a +value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Datastore.FilterSpec.types attribute contains a +value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 2500 datastores match the +Datastore.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.Deployment(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Deployment class provides methods to get the status of the vCenter +appliance deployment. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(state=None, progress=None, subtask_order=None, subtasks=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Deployment.Info class contains attributes to describe the state of +the appliance. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (com.vmware.vcenter.deployment_client.ApplianceState) – State of the vCenter Server Appliance. This attribute was added in +vSphere API 6.7.

    • +

  • progress (com.vmware.cis.task_client.Progress) – The progress info of the current appliance status. This attribute +was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • subtask_order (list of str or None) – The ordered list of subtasks for this deployment operation. This +attribute was added in vSphere API 6.7. +Only set when the appliance state is RUNNING_IN_PROGRESS, +FAILED, CANCELLED and SUCCEEDED.

    • +

  • subtasks ((dict of str and Deployment.Task) or None) – The map of the deployment subtasks and their status infomation. +This attribute was added in vSphere API 6.7. +Only set when the appliance state is RUNNING_IN_PROGRESS, +FAILED, CANCELLED and SUCCEEDED.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+class Task(progress=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Deployment.Task class contains attributes to describe a particular +deployment task. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – The progress info of this deployment task. This attribute was added +in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • result (com.vmware.vcenter.deployment_client.Notifications or None) – Result of the task. This attribute was added in vSphere API 6.7. +This attribute will be None if result is not available at the +current step of the task.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+get()
+

Get the current status of the appliance deployment. This method was +added in vSphere API 6.7.

+
+
Return type
+

Deployment.Info

+
+
Returns
+

Info structure containing the status information about the +appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if appliance state cannot be determined.

+
+
+
+ +
+
+rollback()
+

Rollback a failed appliance so it can be configured once again. This +method was added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the appliance is not in FAILED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.Folder(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Folder class provides methods for manipulating a vCenter Server folder.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(folders=None, names=None, type=None, parent_folders=None, datacenters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Folder.FilterSpec class contains attributes used to filter the +results when listing folders (see Folder.list()). If multiple +attributes are specified, only folders matching all of the attributes match +the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folders (set of str or None) – Identifiers of folders that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, folders with any identifier match the filter.

    • +

  • names (set of str or None) – Names that folders must have to match the filter (see +Folder.Summary.name). +If None or empty, folders with any name match the filter.

    • +

  • type (Folder.Type or None) – Type that folders must have to match the filter (see +Folder.Summary.type). +If None, folders with any type match the filter.

    • +

  • parent_folders (set of str or None) – Folders that must contain the folder for the folder to match the +filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, folder in any folder match the filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the folder for the folder to match +the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, folder in any datacenter match the filter.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'Folder'
+

The resource type for the vCenter folder

+
+ +
+
+class Summary(folder=None, name=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Folder.Summary class contains commonly used information about a +folder.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str) – Identifier of the folder. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder.

    • +

  • name (str) – Name of the vCenter Server folder.

    • +

  • type (Folder.Type) – Type (DATACENTER, DATASTORE, HOST, NETWORK, VIRTUAL_MACHINE) of the +vCenter Server folder.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Folder.Type class defines the type of a vCenter Server folder. The +type of a folder determines what what kinds of children can be contained in +the folder.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DATACENTER = Type(string='DATACENTER')
+

A folder that can contain datacenters.

+
+ +
+
+DATASTORE = Type(string='DATASTORE')
+

A folder that can contain datastores.

+
+ +
+
+HOST = Type(string='HOST')
+

A folder that can contain compute resources (hosts and clusters).

+
+ +
+
+NETWORK = Type(string='NETWORK')
+

A folder that can contain networkds.

+
+ +
+
+VIRTUAL_MACHINE = Type(string='VIRTUAL_MACHINE')
+

A folder that can contain virtual machines.

+
+ +
+ +
+
+list(filter=None)
+

Returns information about at most 1000 visible (subject to permission +checks) folders in vCenter matching the Folder.FilterSpec.

+
+
Parameters
+

filter (Folder.FilterSpec or None) – Specification of matching folders for which information should be +returned. +If None, the behavior is equivalent to a Folder.FilterSpec +with all attributes None which means all folders match the filter.

+
+
Return type
+

list of Folder.Summary

+
+
Returns
+

Commonly used information about the folders matching the +Folder.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Folder.FilterSpec.type attribute contains a value +that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1000 folders match the Folder.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.Host(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Host class provides methods to manage hosts in the vCenter Server.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConnectionState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Host.ConnectionState class defines the connection status of a host.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConnectionState instance.

+
+
+
+
+CONNECTED = ConnectionState(string='CONNECTED')
+

Host is connected to the vCenter Server

+
+ +
+
+DISCONNECTED = ConnectionState(string='DISCONNECTED')
+

Host is disconnected from the vCenter Server

+
+ +
+
+NOT_RESPONDING = ConnectionState(string='NOT_RESPONDING')
+

VirtualCenter is not receiving heartbeats from the server. The state +automatically changes to connected once heartbeats are received again.

+
+ +
+ +
+
+class CreateSpec(hostname=None, port=None, user_name=None, password=None, folder=None, thumbprint_verification=None, thumbprint=None, force_add=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Host.CreateSpec class defines the information used to create a +host.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The IP address or DNS resolvable name of the host.

    • +

  • port (long or None) – The port of the host. +If None, port 443 will be used.

    • +

  • user_name (str) – The administrator account on the host.

    • +

  • password (str) – The password for the administrator account on the host.

    • +

  • folder (str or None) – Host and cluster folder in which the new standalone host should be +created. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose a suitable +folder for the host; if a folder cannot be chosen, the host +creation operation will fail.

    • +

  • thumbprint_verification (Host.CreateSpec.ThumbprintVerification) – Type of host’s SSL certificate verification to be done.

    • +

  • thumbprint (str) – The thumbprint of the SSL certificate, which the host is expected +to have. The thumbprint is always computed using the SHA1 hash and +is the string representation of that hash in the format: +xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where, +‘x’ represents a hexadecimal digit. +This attribute is optional and it is only relevant when the value +of thumbprintVerification is +Host.CreateSpec.ThumbprintVerification.THUMBPRINT.

    • +

  • force_add (bool or None) – Whether host should be added to the vCenter Server even if it is +being managed by another vCenter Server. The original vCenterServer +loses connection to the host. +If None, forceAdd is default to false.

    • +
+
+
+
+
+class ThumbprintVerification(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Host.CreateSpec.ThumbprintVerification class defines the thumbprint +verification schemes for a host’s SSL certificate.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ThumbprintVerification instance.

+
+
+
+
+NONE = ThumbprintVerification(string='NONE')
+

Accept the host’s thumbprint without verifying it.

+
+ +
+
+THUMBPRINT = ThumbprintVerification(string='THUMBPRINT')
+

Host’s SSL certificate verified by checking its thumbprint against the +specified thumbprint.

+
+ +
+ +
+ +
+
+class FilterSpec(hosts=None, names=None, folders=None, datacenters=None, standalone=None, clusters=None, connection_states=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Host.FilterSpec class contains attributes used to filter the +results when listing hosts (see Host.list()). If multiple attributes +are specified, only hosts matching all of the attributes match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hosts (set of str or None) – Identifiers of hosts that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +If None or empty, hosts with any identifier match the filter.

    • +

  • names (set of str or None) – Names that hosts must have to match the filter (see +Host.Summary.name). +If None or empty, hosts with any name match the filter.

    • +

  • folders (set of str or None) – Folders that must contain the hosts for the hosts to match the +filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, hosts in any folder match the filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the hosts for the hosts to match the +filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, hosts in any datacenter match the filter.

    • +

  • standalone (bool or None) – If true, only hosts that are not part of a cluster can match the +filter, and if false, only hosts that are are part of a cluster can +match the filter. +If None Hosts can match filter independent of whether they are part +of a cluster or not. If this field is true and +Host.FilterSpec.clusters os not empty, no hosts will match +the filter.

    • +

  • clusters (set of str or None) – Clusters that must contain the hosts for the hosts to match the +filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None or empty, hosts in any cluster and hosts that are not in a +cluster match the filter. If this attribute is not empty and +Host.FilterSpec.standalone is true, no hosts will match the +filter.

    • +

  • connection_states (set of Host.ConnectionState or None) – Connection states that a host must be in to match the filter (see +Host.Summary.connection_state. +If None or empty, hosts in any connection state match the filter.

    • +
+
+
+
+ +
+
+class PowerState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Host.PowerState class defines the power states of a host.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PowerState instance.

+
+
+
+
+POWERED_OFF = PowerState(string='POWERED_OFF')
+

The host was specifically powered off by the user through vCenter server. +This state is not a cetain state, because after vCenter server issues the +command to power off the host, the host might crash, or kill all the +processes but fail to power off.

+
+ +
+
+POWERED_ON = PowerState(string='POWERED_ON')
+

The host is powered on. A host that is entering standby mode is also in +this state.

+
+ +
+
+STANDBY = PowerState(string='STANDBY')
+

The host was specifically put in standby mode, either explicitly by the +user, or automatically by DPM. This state is not a cetain state, because +after VirtualCenter issues the command to put the host in standby state, +the host might crash, or kill all the processes but fail to enter standby +mode. A host that is exiting standby mode is also in this state.

+
+ +
+ +
+
+RESOURCE_TYPE = 'HostSystem'
+

The resource type for the vCenter Host.

+
+ +
+
+class Summary(host=None, name=None, connection_state=None, power_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Host.Summary class contains commonly used information about a host +in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem.

    • +

  • name (str) – Name of the host.

    • +

  • connection_state (Host.ConnectionState) – Connection status of the host

    • +

  • power_state (Host.PowerState) – Power state of the host +This attribute is optional and it is only relevant when the value +of connectionState is Host.ConnectionState.CONNECTED.

    • +
+
+
+
+ +
+
+connect(host)
+

Connect to the host corresponding to host previously added to the +vCenter server.

+
+
Parameters
+

host (str) – Identifier of the host to be reconnected. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the host associated with host is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+create(spec)
+

Add a new standalone host in the vCenter inventory. The newly connected +host will be in connected state. The vCenter Server will verify the SSL +certificate before adding the host to its inventory. In the case where +the SSL certificate cannot be verified because the Certificate +Authority is not recognized or the certificate is self signed, the +vCenter Server will fall back to thumbprint verification mode as +defined by Host.CreateSpec.ThumbprintVerification.

+
+
Parameters
+

spec (Host.CreateSpec) – Specification for the new host to be created.

+
+
Return type
+

str

+
+
Returns
+

The newly created identifier of the host in vCenter. +The return value will be an identifier for the resource type: +HostSystem.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the host with the same name is already present.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if installation of VirtualCenter agent on a host fails.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the host name is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the host folder is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the SSL thumbprint specified is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the PEM SSL certificate in CreateSpec.sslCertificate is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if both CreateSpec.thumbprint and CreateSpec.sslCertificate are +set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the CreateSpec.sslCertificate argument is not set, and the +CreateSpec.thumbprint argument is set, but the SHA-1 hashing +algorithm is currently disabled for computing certificate +thumbprints.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementType +if the host folder id does not support vSphere compute resource as +its children type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no folder associated with the folder attribute in +the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the host is already being managed by another vCenter Server

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if there are not enough licenses to add the host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user name or password for the administration account on the +host are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the software version on the host is not supported.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+delete(host)
+

Remove a standalone host from the vCenter Server.

+
+
Parameters
+

host (str) – Identifier of the host to be deleted. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the host associated with host is in a vCenter cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+disconnect(host)
+

Disconnect the host corresponding to host from the vCenter server

+
+
Parameters
+

host (str) – Identifier of the host to be disconnected. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the host associated with host is already disconnected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no host associated with host in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 2500 visible (subject to permission +checks) hosts in vCenter matching the Host.FilterSpec.

+
+
Parameters
+

filter (Host.FilterSpec or None) – Specification of matching hosts for which information should be +returned. +If None, the behavior is equivalent to a Host.FilterSpec +with all attributes None which means all hosts match the filter.

+
+
Return type
+

list of Host.Summary

+
+
Returns
+

Commonly used information about the hosts matching the +Host.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Host.FilterSpec.connection_states attribute contains +a value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 2500 hosts match the Host.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.Network(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Network class provides methods for manipulating a vCenter Server +network.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(networks=None, names=None, types=None, folders=None, datacenters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Network.FilterSpec class contains attributes used to filter the +results when listing networks (see Network.list()). If multiple +attributes are specified, only networks matching all of the attributes +match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • networks (set of str or None) – Identifiers of networks that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Network. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Network. +If None or empty, networks with any identifier match the filter.

    • +

  • names (set of str or None) – Names that networks must have to match the filter (see +Network.Summary.name). +If None or empty, networks with any name match the filter.

    • +

  • types (set of Network.Type or None) – Types that networks must have to match the filter (see +Network.Summary.type). +If None, networks with any type match the filter.

    • +

  • folders (set of str or None) – Folders that must contain the network for the network to match the +filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, networks in any folder match the filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the network for the network to match +the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, networks in any datacenter match the filter.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'Network'
+

The resource type for the vCenter network

+
+ +
+
+class Summary(network=None, name=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Network.Summary class contains commonly used information about a +network.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (str) – Identifier of the network. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network.

    • +

  • name (str) – Name of the network.

    • +

  • type (Network.Type) – Type (STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK) of +the vCenter Server network.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Network.Type class defines the type of a vCenter Server network. +The type of a network can be used to determine what features it supports +and which APIs can be used to find more information about the network or +change its configuration.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DISTRIBUTED_PORTGROUP = Type(string='DISTRIBUTED_PORTGROUP')
+

Distributed virtual portgroup (created and managed through vCenter)

+
+ +
+
+OPAQUE_NETWORK = Type(string='OPAQUE_NETWORK')
+

A network whose configuration is managed outside of vSphere. The identifer +and name of the network is made available through vSphere so that host and +virtual machine virtual ethernet devices can connect to them.

+
+ +
+
+STANDARD_PORTGROUP = Type(string='STANDARD_PORTGROUP')
+

vSphere standard portgroup (created and managed on ESX)

+
+ +
+ +
+
+list(filter=None)
+

Returns information about at most 1000 visible (subject to permission +checks) networks in vCenter matching the Network.FilterSpec.

+
+
Parameters
+

filter (Network.FilterSpec or None) – Specification of matching networks for which information should be +returned. +If None, the behavior is equivalent to a +Network.FilterSpec with all attributes None which means +all networks match the filter.

+
+
Return type
+

list of Network.Summary

+
+
Returns
+

Commonly used information about the networks matching the +Network.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Network.FilterSpec.types attribute contains a value +that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1000 networks match the Network.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.ResourcePool(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ResourcePool class provides methods for manipulating a vCenter Server +resource pool.

+

This class does not include virtual appliances in the inventory of resource +pools even though part of the behavior of a virtual appliance is to act +like a resource pool.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, parent=None, cpu_allocation=None, memory_allocation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The class contains information used to create a resource pool, see +ResourcePool.create(). This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the resource pool. This attribute was added in vSphere API +7.0.0.0.

    • +

  • parent (str) – Parent of the created resource pool. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool.

    • +

  • cpu_allocation (ResourcePool.ResourceAllocationCreateSpec or None) – Resource allocation for CPU. This attribute was added in vSphere +API 7.0.0.0. +if None or empty, use the default CPU allocation specification.

    • +

  • memory_allocation (ResourcePool.ResourceAllocationCreateSpec or None) – Resource allocation for memory. This attribute was added in vSphere +API 7.0.0.0. +if None or empty, use the default memory allocation specification.

    • +
+
+
+
+ +
+
+class FilterSpec(resource_pools=None, names=None, parent_resource_pools=None, datacenters=None, hosts=None, clusters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool.FilterSpec class contains attributes used to filter +the results when listing resource pools (see ResourcePool.list()). If +multiple attributes are specified, only resource pools matching all of the +attributes match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • resource_pools (set of str or None) – Identifiers of resource pools that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: ResourcePool. +If None or empty, resource pools with any identifier match the +filter.

    • +

  • names (set of str or None) – Names that resource pools must have to match the filter (see +ResourcePool.Info.name). +If None or empty, resource pools with any name match the filter.

    • +

  • parent_resource_pools (set of str or None) – Resource pools that must contain the resource pool for the resource +pool to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: ResourcePool. +If None or empty, resource pools in any resource pool match the +filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the resource pool for the resource +pool to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, resource pools in any datacenter match the +filter.

    • +

  • hosts (set of str or None) – Hosts that must contain the resource pool for the resource pool to +match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +If None or empty, resource pools in any host match the filter.

    • +

  • clusters (set of str or None) – Clusters that must contain the resource pool for the resource pool +to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None or empty, resource pools in any cluster match the filter.

    • +
+
+
+
+ +
+
+class Info(name=None, resource_pools=None, cpu_allocation=None, memory_allocation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool.Info class contains information about a resource pool.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the vCenter Server resource pool.

    • +

  • resource_pools (set of str) – Identifiers of the child resource pools contained in this resource +pool. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: ResourcePool.

    • +

  • cpu_allocation (ResourcePool.ResourceAllocationInfo) – Resource allocation information for CPU. This attribute was added +in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • memory_allocation (ResourcePool.ResourceAllocationInfo) – Resource allocation information for memory. This attribute was +added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'ResourcePool'
+

The resource type for the vCenter resource pool

+
+ +
+
+class ResourceAllocationCreateSpec(reservation=None, expandable_reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool.ResourceAllocationCreateSpec class contains resource +allocation information used to create a resource pool, see +ResourcePool.create(). This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long or None) – Amount of resource that is guaranteed available to a resource pool. +Reserved resources are not wasted if they are not used. If the +utilization is less than the reservation, the resources can be +utilized by other running virtual machines. Units are MB fo memory, +and MHz for CPU. This attribute was added in vSphere API 7.0.0.0. +If None or empty, +ResourcePool.ResourceAllocationCreateSpec.reservation will +be set to 0.

    • +

  • expandable_reservation (bool or None) – In a resource pool with an expandable reservation, the reservation +can grow beyond the specified value, if the parent resource pool +has unreserved resources. A non-expandable reservation is called a +fixed reservation. This attribute was added in vSphere API 7.0.0.0. +If None or empty, +ResourcePool.ResourceAllocationCreateSpec.expandable_reservation +will be set to true.

    • +

  • limit (long or None) – The utilization of a resource pool will not exceed this limit, even +if there are available resources. This is typically used to ensure +a consistent performance of resource pools independent of available +resources. If set to -1, then there is no fixed limit on resource +usage (only bounded by available resources and shares). Units are +MB for memory, and MHz for CPU. This attribute was added in vSphere +API 7.0.0.0. +If None or empty, +ResourcePool.ResourceAllocationCreateSpec.limit will be set +to -1.

    • +

  • shares (ResourcePool.SharesInfo or None) – Shares are used in case of resource contention. This attribute was +added in vSphere API 7.0.0.0. +If None or empty, +ResourcePool.ResourceAllocationCreateSpec.shares will be +set to ‘ResourcePool.SharesInfo.Level.NORMAL’.

    • +
+
+
+
+ +
+
+class ResourceAllocationInfo(reservation=None, expandable_reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool.ResourceAllocationInfo class contains resource +allocation information of a resource pool. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long) – Amount of resource that is guaranteed available to a resource pool. +Reserved resources are not wasted if they are not used. If the +utilization is less than the reservation, the resources can be +utilized by other running virtual machines. Units are MB fo memory, +and MHz for CPU. This attribute was added in vSphere API 7.0.0.0.

    • +

  • expandable_reservation (bool) – In a resource pool with an expandable reservation, the reservation +can grow beyond the specified value, if the parent resource pool +has unreserved resources. A non-expandable reservation is called a +fixed reservation. This attribute was added in vSphere API 7.0.0.0.

    • +

  • limit (long) – The utilization of a resource pool will not exceed this limit, even +if there are available resources. This is typically used to ensure +a consistent performance of resource pools independent of available +resources. If set to -1, then there is no fixed limit on resource +usage (only bounded by available resources and shares). Units are +MB for memory, and MHz for CPU. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • shares (ResourcePool.SharesInfo) – Shares are used in case of resource contention. This attribute was +added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class ResourceAllocationUpdateSpec(reservation=None, expandable_reservation=None, limit=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAllocationUpdateSpec class descrives the updates to be made +to the resource allocation settings of a resource pool. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long or None) – Amount of resource that is guaranteed available to a resource pool. +Reserved resources are not wasted if they are not used. If the +utilization is less than the reservation, the resources can be +utilized by other running virtual machines. Units are MB fo memory, +and MHz for CPU. This attribute was added in vSphere API 7.0.0.0. +If None or empty, reservation will be set to 0.

    • +

  • expandable_reservation (bool or None) – In a resource pool with an expandable reservation, the reservation +can grow beyond the specified value, if the parent resource pool +has unreserved resources. A non-expandable reservation is called a +fixed reservation. This attribute was added in vSphere API 7.0.0.0. +If None or empty, expandableReservation will be set to true.

    • +

  • limit (long or None) – The utilization of a resource pool will not exceed this limit, even +if there are available resources. This is typically used to ensure +a consistent performance of resource pools independent of available +resources. If set to -1, then there is no fixed limit on resource +usage (only bounded by available resources and shares). Units are +MB for memory, and MHz for CPU. This attribute was added in vSphere +API 7.0.0.0. +If None or empty, limit will be set to -1.

    • +

  • shares (ResourcePool.SharesInfo or None) – Shares are used in case of resource contention. This attribute was +added in vSphere API 7.0.0.0. +If None or empty, shares will be set to +‘ResourcePool.SharesInfo.Level.NORMAL’.

    • +
+
+
+
+ +
+
+class SharesInfo(level=None, shares=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool.SharesInfo class provides specification of shares.

+

Shares are used to determine relative allocation between resource +consumers. In general, a consumer with more shares gets proportionally more +of the resource, subject to certain other constraints.. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • level (ResourcePool.SharesInfo.Level) – The allocation level. It maps to a pre-determined set of numeric +values for shares. If the shares value does not map to a predefined +size, then the level is set as CUSTOM. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • shares (long) –

    When ResourcePool.SharesInfo.level is set to CUSTOM, it is +the number of shares allocated. Otherwise, this value is ignored.

    +

    There is no unit for this value. It is a relative measure based on +the settings for other resource pools.. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of level is ResourcePool.SharesInfo.Level.CUSTOM.

    +

    • +
+
+
+
+
+class Level(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ResourcePool.SharesInfo.Level class defines the possible values for +the allocation level. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Level instance.

+
+
+
+
+CUSTOM = Level(string='CUSTOM')
+

If set, in case there is resource contention the server uses the +shares value to determine the resource allocation. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+HIGH = Level(string='HIGH')
+

For CPU: Shares = 2000 * number of virtual CPUs. +For Memory: Shares = 20 * virtual machine memory size in MB. +. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+LOW = Level(string='LOW')
+

For CPU: Shares = 500 * number of virtual CPUs. +For Memory: Shares = 5 * virtual machine memory size in MB. +. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+NORMAL = Level(string='NORMAL')
+

For CPU: Shares = 1000 * number of virtual CPUs. +For Memory: Shares = 10 * virtual machine memory size in MB. +. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class Summary(resource_pool=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourcePool.Summary class contains commonly used information about +a resource pool in vCenter Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • resource_pool (str) – Identifier of the resource pool. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool.

    • +

  • name (str) – Name of the resource pool.

    • +
+
+
+
+ +
+
+class UpdateSpec(name=None, cpu_allocation=None, memory_allocation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The class contains specification for updating the configuration of a +resource pool. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Name of the resource pool. This attribute was added in vSphere API +7.0.0.0. +if None or empty, the name of the resource pool will not be +changed.

    • +

  • cpu_allocation (ResourcePool.ResourceAllocationUpdateSpec or None) – Resource allocation for CPU. This attribute was added in vSphere +API 7.0.0.0. +if None or empty, the CPU allocation of the resource pool will not +be changed.

    • +

  • memory_allocation (ResourcePool.ResourceAllocationUpdateSpec or None) – Resource allocation for memory. This attribute was added in vSphere +API 7.0.0.0. +if None or empty, the memory allocation of the resource pool will +not be changed.

    • +
+
+
+
+ +
+
+create(spec)
+

Creates a resource pool. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (ResourcePool.CreateSpec) – Specification of the new resource pool to be created, see +ResourcePool.CreateSpec.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the newly created resource pool. +The return value will be an identifier for the resource type: +ResourcePool.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If a parameter passed in the spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the resource specified in parent could not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +If the specified resource in parent is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to create the resource pool could +not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource ResourcePool referenced by the attribute +ResourcePool.CreateSpec.parent requires +Resource.CreatePool.

    • +
+
+
+
+ +
+
+delete(resource_pool)
+

Deletes a resource pool. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

resource_pool (str) – Identifier of the resource pool to be deleted. +The parameter must be an identifier for the resource type: +ResourcePool.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the resource pool is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the resource pool is a root resource pool.

+
+
+
+ +
+
+get(resource_pool)
+

Retrieves information about the resource pool indicated by +resource_pool.

+
+
Parameters
+

resource_pool (str) – Identifier of the resource pool for which information should be +retrieved. +The parameter must be an identifier for the resource type: +ResourcePool.

+
+
Return type
+

ResourcePool.Info

+
+
Returns
+

Information about the resource pool.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the resource pool indicated by resource_pool does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource ResourcePool referenced by the parameter +resource_pool requires System.Read.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 1000 visible (subject to permission +checks) resource pools in vCenter matching the +ResourcePool.FilterSpec.

+
+
Parameters
+

filter (ResourcePool.FilterSpec or None) – Specification of matching resource pools for which information +should be returned. +If None, the behavior is equivalent to a +ResourcePool.FilterSpec with all attributes None which +means all resource pools match the filter.

+
+
Return type
+

list of ResourcePool.Summary

+
+
Returns
+

Commonly used information about the resource pools matching the +ResourcePool.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +If more than 1000 resource pools match the +ResourcePool.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(resource_pool, spec)
+

Updates the configuration of a resource pool. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • resource_pool (str) – Identifier of the resource pool. +The parameter must be an identifier for the resource type: +ResourcePool.

    • +

  • spec (ResourcePool.UpdateSpec) – Specification for updating the configuration of the resource pool.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If any of the specified parameters is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the resource pool is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +If the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +If any of the resources needed to reconfigure the resource pool +could not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource ResourcePool referenced by the parameter +resource_pool requires Resource.EditPool.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter_client.System(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The System class contains methods for negotiating API communication +parameters including release ID.

+

Software developers obtain a list of supported API release IDs from vCenter +documentation or as part of the client library (SDK) they work with at the +time they develop and test a solution. The software solution initiates a +handshake by sending a prioritized list of release IDs supported by the +solution. The server selects the first release ID it supports from the +list.

+

Negotiating API release ID is necessary to use APIs utilizing inheritance +based polymorphism. These include all VI/JSON APIs and a set of vSphere +Automation APIs. vSphere Automation APIs that require API release ID state +this in their documentation. Consult the Programming Guide and API +reference documentation of specific methods for more information.. This +class was added in vSphere API 8.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class HelloResult(api_release=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The System.HelloResult class contains common API communication +parameters. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

api_release (str) – Mutually supported API release ID to be used in subsequent API +calls to the current vCenter system. This attribute was added in +vSphere API 8.0.2.0.

+
+
+
+ +
+
+class HelloSpec(api_releases=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The System.HelloSpec class describes the API client preferences. This +class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

api_releases (list of str) – List of API release IDs that the client can work with in order of +preference. The server will select the first mutually supported +release ID. This attribute was added in vSphere API 8.0.2.0.

+
+
+
+ +
+
+hello(spec)
+

Negotiates common parameters for API communication.

+

This method selects mutually supported choices from the +System.HelloSpec.api_releases list.. This method was added in +vSphere API 8.0.2.0.

+
+
Parameters
+

spec (System.HelloSpec) – Client capabilities including list of supported API release IDs.

+
+
Return type
+

System.HelloResult

+
+
Returns
+

Common parameters for API communication.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no mutually supported release ID exists. For example, if all +releases requested by the client are unsupported or unknown to the +current endpoint.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the list of client provided release IDs +(System.HelloSpec.api_releases) is empty or the list is +longer then 128 releases or given release ID is longer then 64 +characters.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter_client.VM(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The VM class provides methods for managing the lifecycle of a virtual +machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ClonePlacementSpec(folder=None, resource_pool=None, host=None, cluster=None, datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.ClonePlacementSpec class contains information used to place a +clone of a virtual machine onto resources within the vCenter inventory. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the cloned virtual machine should +be placed. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +If attribute is None, the system will use the virtual machine +folder of the source virtual machine. If this results in a conflict +due to other placement parameters, the virtual machine clone +operation will fail.

    • +

  • resource_pool (str or None) – Resource pool into which the cloned virtual machine should be +placed. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +If attribute is None, the system will use the resource pool of the +source virtual machine. If this results in a conflict due to other +placement parameters, the virtual machine clone operation will +fail.

    • +

  • host (str or None) –

    Host onto which the cloned virtual machine should be placed.

    +

    If host and resourcePool are both specified, +resourcePool must belong to host.

    +

    If host and cluster are both specified, host must be a +member of cluster.. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +If this attribute is unset, if resourcePool is unset, the +cloned virtual machine will use the host of the source virtual +machine. if resourcePool is set, and the target is a standalone +host, the host is used. if resourcePool is set, and the target +is a DRS cluster, a host will be picked by DRS. if resourcePool +is set, and the target is a cluster without DRS, InvalidArgument +will be thrown.

    +

    • +

  • cluster (str or None) –

    Cluster into which the cloned virtual machine should be placed.

    +

    If cluster and resourcePool are both specified, +resourcePool must belong to cluster.

    +

    If cluster and host are both specified, host must be a +member of cluster.. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    +

    • +

  • datastore (str or None) – Datastore on which the cloned virtual machine’s configuration state +should be stored. This datastore will also be used for any virtual +disks that are created as part of the virtual machine clone +operation unless individually overridden. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +If attribute is None, the system will use the datastore of the +source virtual machine.

    • +
+
+
+
+ +
+
+class CloneSpec(source=None, name=None, placement=None, disks_to_remove=None, disks_to_update=None, power_on=None, guest_customization_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based clone spec. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source (str) – Virtual machine to clone from. This attribute was added in vSphere +API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: VirtualMachine.

    • +

  • name (str) – Virtual machine name. This attribute was added in vSphere API +7.0.0.0.

    • +

  • placement (VM.ClonePlacementSpec or None) – Virtual machine placement information. This attribute was added in +vSphere API 7.0.0.0. +If this attribute is None, the system will use the values from the +source virtual machine. If specified, each field will be used for +placement. If the fields result in disjoint placement the operation +will fail. If the fields along with the placement values of the +source virtual machine result in disjoint placement the operation +will fail.

    • +

  • disks_to_remove (set of str or None) – Set of Disks to Remove. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None, all disks will be copied. If the same identifier is in +VM.CloneSpec.disks_to_update InvalidArgument fault will be +returned.

    • +

  • disks_to_update ((dict of str and VM.DiskCloneSpec) or None) – Map of Disks to Update. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None, all disks will copied to the datastore specified in the +VM.ClonePlacementSpec.datastore attribute of +VM.CloneSpec.placement. If the same identifier is in +VM.CloneSpec.disks_to_remove InvalidArgument fault will be +thrown.

    • +

  • power_on (bool or None) – Attempt to perform a VM.CloneSpec.power_on after clone. +This attribute was added in vSphere API 7.0.0.0. +If None, the virtual machine will not be powered on.

    • +

  • guest_customization_spec (VM.GuestCustomizationSpec or None) – Guest customization spec to apply to the virtual machine after the +virtual machine is deployed. This attribute was added in vSphere +API 7.0.0.0. +If None, the guest operating system is not customized after clone.

    • +
+
+
+
+ +
+
+class ComputePlacementSpec(resource_pool=None, host=None, cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.ComputePlacementSpec class contains information used to place a +virtual machine on compute resources.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • resource_pool (str or None) – Resource pool into which the virtual machine should be placed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +This attribute is currently required if both host and +cluster are None. In the future, if this attribute is None, the +system will attempt to choose a suitable resource pool for the +virtual machine; if a resource pool cannot be chosen, the virtual +machine creation operation will fail.

    • +

  • host (str or None) –

    Host onto which the virtual machine should be placed.

    +

    If host and resourcePool are both specified, +resourcePool must belong to host.

    +

    If host and cluster are both specified, host must be a +member of cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute may be None if resourcePool or cluster is +specified. If None, the system will attempt to choose a suitable +host for the virtual machine; if a host cannot be chosen, the +virtual machine creation operation will fail.

    +

    • +

  • cluster (str or None) –

    Cluster into which the virtual machine should be placed.

    +

    If cluster and resourcePool are both specified, +resourcePool must belong to cluster.

    +

    If cluster and host are both specified, host must be a +member of cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    +

    • +
+
+
+
+ +
+
+class CreateSpec(guest_os=None, name=None, placement=None, hardware_version=None, boot=None, boot_devices=None, cpu=None, memory=None, disks=None, nics=None, cdroms=None, floppies=None, parallel_ports=None, serial_ports=None, sata_adapters=None, scsi_adapters=None, nvme_adapters=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based creation spec.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • guest_os (com.vmware.vcenter.vm_client.GuestOS) – Guest OS.

    • +

  • name (str or None) – Virtual machine name. +If None, a default name will be generated by the server.

    • +

  • placement (VM.PlacementSpec or None) – Virtual machine placement information. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose suitable +resources on which to place the virtual machine.

    • +

  • hardware_version (com.vmware.vcenter.vm_client.Hardware.Version or None) – Virtual hardware version. +If None, defaults to the most recent version supported by the +server.

    • +

  • boot (com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec or None) – Boot configuration. +If None, guest-specific default values will be used.

    • +

  • boot_devices (list of com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec or None) – Boot device configuration. +If None, a server-specific boot sequence will be used.

    • +

  • cpu (com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec or None) – CPU configuration. +If None, guest-specific default values will be used.

    • +

  • memory (com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec or None) – Memory configuration. +If None, guest-specific default values will be used.

    • +

  • disks (list of com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec or None) – List of disks. +If None, a single blank virtual disk of a guest-specific size will +be created on the same storage as the virtual machine +configuration, and will use a guest-specific host bus adapter type. +If the guest-specific size is 0, no virtual disk will be created.

    • +

  • nics (list of com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec or None) – List of Ethernet adapters. +If None, no Ethernet adapters will be created.

    • +

  • cdroms (list of com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec or None) – List of CD-ROMs. +If None, no CD-ROM devices will be created.

    • +

  • floppies (list of com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec or None) – List of floppy drives. +If None, no floppy drives will be created.

    • +

  • parallel_ports (list of com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec or None) – List of parallel ports. +If None, no parallel ports will be created.

    • +

  • serial_ports (list of com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec or None) – List of serial ports. +If None, no serial ports will be created.

    • +

  • sata_adapters (list of com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec or None) – List of SATA adapters. +If None, any adapters necessary to connect the virtual machine’s +storage devices will be created; this includes any devices that +explicitly specify a SATA host bus adapter, as well as any devices +that do not specify a host bus adapter if the guest’s preferred +adapter type is SATA.

    • +

  • scsi_adapters (list of com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec or None) – List of SCSI adapters. +If None, any adapters necessary to connect the virtual machine’s +storage devices will be created; this includes any devices that +explicitly specify a SCSI host bus adapter, as well as any devices +that do not specify a host bus adapter if the guest’s preferred +adapter type is SCSI. The type of the SCSI adapter will be a +guest-specific default type.

    • +

  • nvme_adapters (list of com.vmware.vcenter.vm.hardware.adapter_client.Nvme.CreateSpec or None) – List of NVMe adapters. This attribute was added in vSphere API +7.0.0.1. +If None, any adapters necessary to connect the virtual machine’s +storage devices will be created; this includes any devices that +explicitly specify a NVMe host bus adapter, as well as any devices +that do not specify a host bus adapter if the guest’s preferred +adapter type is NVMe.

    • +

  • storage_policy (VM.StoragePolicySpec or None) – The VM.StoragePolicySpec class contains information about the +storage policy that is to be associated with the virtual machine +home (which contains the configuration and log files). This +attribute was added in vSphere API 6.7. +If None the datastore default storage policy (if applicable) is +applied. Currently a default storage policy is only supported by +object datastores : VVol and vSAN. For non-object datastores, if +None then no storage policy would be associated with the virtual +machine home.

    • +
+
+
+
+ +
+
+class DiskCloneSpec(datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based disk clone spec. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

datastore (str or None) – Destination datastore to clone disk. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required. In the future, if this +attribute is None disk will be copied to the datastore specified in +the VM.ClonePlacementSpec.datastore attribute of +VM.CloneSpec.placement.

+
+
+
+ +
+
+class DiskRelocateSpec(datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based disk relocate spec. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

datastore (str or None) – Destination datastore to relocate disk. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required. In the future, if this +attribute is unset, disk will use the datastore specified in +VM.RelocatePlacementSpec.datastore attribute of +VM.RelocateSpec.placement.

+
+
+
+ +
+
+class FilterSpec(vms=None, names=None, folders=None, datacenters=None, hosts=None, clusters=None, resource_pools=None, power_states=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.FilterSpec class contains attributes used to filter the results +when listing virtual machines (see VM.list()). If multiple attributes +are specified, only virtual machines matching all of the attributes match +the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vms (set of str or None) – Identifiers of virtual machines that can match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: VirtualMachine. +If None or empty, virtual machines with any identifier match the +filter.

    • +

  • names (set of str or None) – Names that virtual machines must have to match the filter (see +VM.Info.name). +If None or empty, virtual machines with any name match the filter.

    • +

  • folders (set of str or None) – Folders that must contain the virtual machine for the virtual +machine to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Folder. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Folder. +If None or empty, virtual machines in any folder match the filter.

    • +

  • datacenters (set of str or None) – Datacenters that must contain the virtual machine for the virtual +machine to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datacenter. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datacenter. +If None or empty, virtual machines in any datacenter match the +filter.

    • +

  • hosts (set of str or None) – Hosts that must contain the virtual machine for the virtual machine +to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +If None or empty, virtual machines on any host match the filter.

    • +

  • clusters (set of str or None) – Clusters that must contain the virtual machine for the virtual +machine to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None or empty, virtual machines in any cluster match the filter.

    • +

  • resource_pools (set of str or None) – Resource pools that must contain the virtual machine for the +virtual machine to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: ResourcePool. +If None or empty, virtual machines in any resource pool match the +filter.

    • +

  • power_states (set of com.vmware.vcenter.vm_client.Power.State or None) – Power states that a virtual machine must be in to match the filter +(see com.vmware.vcenter.vm_client.Power.Info.state. +If None or empty, virtual machines in any power state match the +filter.

    • +
+
+
+
+ +
+
+class GuestCustomizationSpec(name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.GuestCustomizationSpec class contains information required to +customize a virtual machine when deploying it. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

name (str or None) – Name of the customization specification. This attribute was added +in vSphere API 7.0.0.0. +If None, no guest customization is performed.

+
+
+
+ +
+
+class Info(guest_os=None, name=None, identity=None, power_state=None, instant_clone_frozen=None, hardware=None, boot=None, boot_devices=None, cpu=None, memory=None, disks=None, nics=None, cdroms=None, floppies=None, parallel_ports=None, serial_ports=None, sata_adapters=None, scsi_adapters=None, nvme_adapters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based info.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • guest_os (com.vmware.vcenter.vm_client.GuestOS) – Guest OS.

    • +

  • name (str) – Virtual machine name.

    • +

  • identity (com.vmware.vcenter.vm_client.Identity.Info) – Identity of the virtual machine. This attribute was added in +vSphere API 6.7.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • power_state (com.vmware.vcenter.vm_client.Power.State) – Power state of the virtual machine.

    • +

  • instant_clone_frozen (bool) – Indicates whether the virtual machine is frozen for instant clone, +or not. This attribute was added in vSphere API 6.7.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • hardware (com.vmware.vcenter.vm_client.Hardware.Info) – Virtual hardware version information.

    • +

  • boot (com.vmware.vcenter.vm.hardware_client.Boot.Info) – Boot configuration.

    • +

  • boot_devices (list of com.vmware.vcenter.vm.hardware.boot_client.Device.Entry) – Boot device configuration. If the list has no entries, a +server-specific default boot sequence is used.

    • +

  • cpu (com.vmware.vcenter.vm.hardware_client.Cpu.Info) – CPU configuration.

    • +

  • memory (com.vmware.vcenter.vm.hardware_client.Memory.Info) – Memory configuration.

    • +

  • disks (dict of str and com.vmware.vcenter.vm.hardware_client.Disk.Info) – List of disks. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +

  • nics (dict of str and com.vmware.vcenter.vm.hardware_client.Ethernet.Info) – List of Ethernet adapters. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet.

    • +

  • cdroms (dict of str and com.vmware.vcenter.vm.hardware_client.Cdrom.Info) – List of CD-ROMs. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Cdrom. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +

  • floppies (dict of str and com.vmware.vcenter.vm.hardware_client.Floppy.Info) – List of floppy drives. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Floppy. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Floppy.

    • +

  • parallel_ports (dict of str and com.vmware.vcenter.vm.hardware_client.Parallel.Info) – List of parallel ports. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.ParallelPort. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.ParallelPort.

    • +

  • serial_ports (dict of str and com.vmware.vcenter.vm.hardware_client.Serial.Info) – List of serial ports. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.SerialPort. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.SerialPort.

    • +

  • sata_adapters (dict of str and com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info) – List of SATA adapters. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.SataAdapter. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.SataAdapter.

    • +

  • scsi_adapters (dict of str and com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info) – List of SCSI adapters. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.ScsiAdapter.

    • +

  • nvme_adapters (dict of str and com.vmware.vcenter.vm.hardware.adapter_client.Nvme.Info) – List of NVMe adapters. This attribute was added in vSphere API +7.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.NvmeAdapter. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.NvmeAdapter. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class InstantClonePlacementSpec(folder=None, resource_pool=None, datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.InstantClonePlacementSpec class contains information used to +place an InstantClone of a virtual machine onto resources within the +vCenter inventory. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the InstantCloned virtual machine +should be placed. This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +If attribute is None, the system will use the virtual machine +folder of the source virtual machine.

    • +

  • resource_pool (str or None) – Resource pool into which the InstantCloned virtual machine should +be placed. This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +If attribute is None, the system will use the resource pool of the +source virtual machine.

    • +

  • datastore (str or None) – Datastore on which the InstantCloned virtual machine’s +configuration state should be stored. This datastore will also be +used for any virtual disks that are created as part of the virtual +machine InstantClone operation. This attribute was added in vSphere +API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +If attribute is None, the system will use the datastore of the +source virtual machine.

    • +
+
+
+
+ +
+
+class InstantCloneSpec(source=None, name=None, placement=None, nics_to_update=None, disconnect_all_nics=None, parallel_ports_to_update=None, serial_ports_to_update=None, bios_uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based InstantClone spec. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source (str) – Virtual machine to InstantClone from. This attribute was added in +vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: VirtualMachine.

    • +

  • name (str) – Name of the new virtual machine. This attribute was added in +vSphere API 6.7.1.

    • +

  • placement (VM.InstantClonePlacementSpec or None) – Virtual machine placement information. This attribute was added in +vSphere API 6.7.1. +If this attribute is None, the system will use the values from the +source virtual machine. If specified, each field will be used for +placement. If the fields result in disjoint placement the operation +will fail. If the fields along with the placement values of the +source virtual machine result in disjoint placement the operation +will fail.

    • +

  • nics_to_update ((dict of str and com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec) or None) – Map of NICs to update. This attribute was added in vSphere API +6.7.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet. +If None, no NICs will be updated.

    • +

  • disconnect_all_nics (bool or None) – Indicates whether all NICs on the destination virtual machine +should be disconnected from the newtwork. This attribute was added +in vSphere API 6.7.1. +If None, connection status of all NICs on the destination virtual +machine will be the same as on the source virtual machine.

    • +

  • parallel_ports_to_update ((dict of str and com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec) or None) – Map of parallel ports to Update. This attribute was added in +vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.ParallelPort. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.ParallelPort. +If None, no parallel ports will be updated.

    • +

  • serial_ports_to_update ((dict of str and com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec) or None) – Map of serial ports to Update. This attribute was added in vSphere +API 6.7.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.SerialPort. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.SerialPort. +If None, no serial ports will be updated.

    • +

  • bios_uuid (str or None) – 128-bit SMBIOS UUID of a virtual machine represented as a +hexadecimal string in “12345678-abcd-1234-cdef-123456789abc” +format. This attribute was added in vSphere API 6.7.1. +If None, will be generated.

    • +
+
+
+
+ +
+
+class InventoryPlacementSpec(folder=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.InventoryPlacementSpec class contains information used to place +a virtual machine in the vCenter inventory.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

folder (str or None) – Virtual machine folder into which the virtual machine should be +placed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose a suitable +folder for the virtual machine; if a folder cannot be chosen, the +virtual machine creation operation will fail.

+
+
+
+ +
+
+class PlacementSpec(folder=None, resource_pool=None, host=None, cluster=None, datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.PlacementSpec class contains information used to place a virtual +machine onto resources within the vCenter inventory.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine should be +placed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose a suitable +folder for the virtual machine; if a folder cannot be chosen, the +virtual machine creation operation will fail.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine should be placed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +This attribute is currently required if both host and +cluster are None. In the future, if this attribute is None, the +system will attempt to choose a suitable resource pool for the +virtual machine; if a resource pool cannot be chosen, the virtual +machine creation operation will fail.

    • +

  • host (str or None) –

    Host onto which the virtual machine should be placed.

    +

    If host and resourcePool are both specified, +resourcePool must belong to host.

    +

    If host and cluster are both specified, host must be a +member of cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute may be None if resourcePool or cluster is +specified. If None, the system will attempt to choose a suitable +host for the virtual machine; if a host cannot be chosen, the +virtual machine creation operation will fail.

    +

    • +

  • cluster (str or None) –

    Cluster into which the virtual machine should be placed.

    +

    If cluster and resourcePool are both specified, +resourcePool must belong to cluster.

    +

    If cluster and host are both specified, host must be a +member of cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    +

    • +

  • datastore (str or None) – Datastore on which the virtual machine’s configuration state should +be stored. This datastore will also be used for any virtual disks +that are created as part of the virtual machine creation operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose suitable +storage for the virtual machine; if storage cannot be chosen, the +virtual machine creation operation will fail.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'VirtualMachine'
+

Resource type for virtual machines.

+
+ +
+
+class RegisterPlacementSpec(folder=None, resource_pool=None, host=None, cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.RegisterPlacementSpec class contains information used to place a +virtual machine, created from existing virtual machine files on storage, +onto resources within the vCenter inventory. This class was added in +vSphere API 6.8.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine should be +placed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose a suitable +folder for the virtual machine; if a folder cannot be chosen, the +virtual machine creation operation will fail.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine should be placed. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +This attribute is currently required if both host and +cluster are None. In the future, if this attribute is None, the +system will attempt to choose a suitable resource pool for the +virtual machine; if a resource pool cannot be chosen, the virtual +machine creation operation will fail.

    • +

  • host (str or None) –

    Host onto which the virtual machine should be placed.

    +

    If host and resourcePool are both specified, +resourcePool must belong to host.

    +

    If host and cluster are both specified, host must be a +member of cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute may be None if resourcePool or cluster is +specified. If None, the system will attempt to choose a suitable +host for the virtual machine; if a host cannot be chosen, the +virtual machine creation operation will fail.

    +

    • +

  • cluster (str or None) –

    Cluster into which the virtual machine should be placed.

    +

    If cluster and resourcePool are both specified, +resourcePool must belong to cluster.

    +

    If cluster and host are both specified, host must be a +member of cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    +

    • +
+
+
+
+ +
+
+class RegisterSpec(datastore=None, path=None, datastore_path=None, name=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.RegisterSpec class contains information used to create a virtual +machine from existing virtual machine files on storage.

+

The location of the virtual machine files on storage must be specified by +providing either VM.RegisterSpec.datastore and +VM.RegisterSpec.path or by providing +VM.RegisterSpec.datastore_path. If +VM.RegisterSpec.datastore and VM.RegisterSpec.path are +set, VM.RegisterSpec.datastore_path must be None, and if +VM.RegisterSpec.datastore_path is set, +VM.RegisterSpec.datastore and VM.RegisterSpec.path must be +None.. This class was added in vSphere API 6.8.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str or None) – Identifier of the datastore on which the virtual machine’s +configuration state is stored. This attribute was added in vSphere +API 6.8.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +If None, VM.RegisterSpec.path must also be None and +VM.RegisterSpec.datastore_path must be set.

    • +

  • path (str or None) – Path to the virtual machine’s configuration file on the datastore +corresponding to {\@link #datastore). This attribute was added +in vSphere API 6.8.7. +If None, VM.RegisterSpec.datastore must also be None and +VM.RegisterSpec.datastore_path must be set.

    • +

  • datastore_path (str or None) – Datastore path for the virtual machine’s configuration file in the +format “[datastore name] path”. For example “[storage1] +Test-VM/Test-VM.vmx”. This attribute was added in vSphere API +6.8.7. +If None, both VM.RegisterSpec.datastore and +VM.RegisterSpec.path must be set.

    • +

  • name (str or None) – Virtual machine name. This attribute was added in vSphere API +6.8.7. +If None, the display name from the virtual machine’s configuration +file will be used.

    • +

  • placement (VM.RegisterPlacementSpec or None) – Virtual machine placement information. This attribute was added in +vSphere API 6.8.7. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose suitable +resources on which to place the virtual machine.

    • +
+
+
+
+ +
+
+class RelocatePlacementSpec(folder=None, resource_pool=None, host=None, cluster=None, datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.RelocatePlacementSpec class contains information used to change +the placement of an existing virtual machine within the vCenter inventory. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine should be +placed. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +If this attribute is None, the virtual machine will stay in the +current folder.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine should be placed. This +attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +If this attribute is None, the virtual machine will stay in the +current resource pool.

    • +

  • host (str or None) –

    Host onto which the virtual machine should be placed.

    +

    If host and resourcePool are both specified, +resourcePool must belong to host.

    +

    If host and cluster are both specified, host must be a +member of cluster.. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +If this attribute is unset, if resourcePool is unset, the +virtual machine will remain on the current host. if +resourcePool is set, and the target is a standalone host, the +host is used. if resourcePool is set, and the target is a DRS +cluster, a host will be picked by DRS. if resourcePool is set, +and the target is a cluster without DRS, InvalidArgument will be +thrown.

    +

    • +

  • cluster (str or None) –

    Cluster into which the virtual machine should be placed.

    +

    If cluster and resourcePool are both specified, +resourcePool must belong to cluster.

    +

    If cluster and host are both specified, host must be a +member of cluster.. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    +

    • +

  • datastore (str or None) – Datastore on which the virtual machine’s configuration state should +be stored. This datastore will also be used for any virtual disks +that are associated with the virtual machine, unless individually +overridden. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +If this attribute is None, the virtual machine will remain on the +current datastore.

    • +
+
+
+
+ +
+
+class RelocateSpec(placement=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Document-based relocate spec. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • placement (VM.RelocatePlacementSpec or None) – Virtual machine placement information. This attribute was added in +vSphere API 7.0.0.0. +If this attribute is None, the system will use the values from the +source virtual machine. If specified, each field will be used for +placement. If the fields result in disjoint placement the operation +will fail. If the fields along with the other existing placement of +the virtual machine result in disjoint placement the operation will +fail.

    • +

  • disks ((dict of str and VM.DiskRelocateSpec) or None) – Individual disk relocation map. This attribute was added in vSphere +API 7.0.0.0. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None, all disks will migrate to the datastore specified in the +VM.RelocatePlacementSpec.datastore attribute of +VM.RelocateSpec.placement.

    • +
+
+
+
+ +
+
+class StoragePlacementSpec(datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.StoragePlacementSpec class contains information used to store a +virtual machine’s files.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

datastore (str or None) – Datastore on which the virtual machine’s configuration state should +be stored. This datastore will also be used for any virtual disks +that are created as part of the virtual machine creation operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required. In the future, if this +attribute is None, the system will attempt to choose suitable +storage for the virtual machine; if storage cannot be chosen, the +virtual machine creation operation will fail.

+
+
+
+ +
+
+class StoragePolicySpec(policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.StoragePolicySpec class contains information about the storage +policy to be associated with a virtual machine object. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

policy (str) – Identifier of the storage policy which should be associated with +the virtual machine. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy.

+
+
+
+ +
+
+class Summary(vm=None, name=None, power_state=None, cpu_count=None, memory_size_mib=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.Summary class contains commonly used information about a virtual +machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: VirtualMachine.

    • +

  • name (str) – Name of the Virtual machine.

    • +

  • power_state (com.vmware.vcenter.vm_client.Power.State) – Power state of the virtual machine.

    • +

  • cpu_count (long or None) – Number of CPU cores. +This attribute will be None if the virtual machine configuration is +not available. For example, the configuration information would be +unavailable if the server is unable to access the virtual machine +files on disk, and is often also unavailable during the intial +phases of virtual machine creation.

    • +

  • memory_size_mib (long or None) – Memory size in mebibytes. +This attribute will be None if the virtual machine configuration is +not available. For example, the configuration information would be +unavailable if the server is unable to access the virtual machine +files on disk, and is often also unavailable during the intial +phases of virtual machine creation.

    • +
+
+
+
+ +
+
+clone(spec)
+

Creates a virtual machine from an existing virtual machine.

+

. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (VM.CloneSpec) – Virtual machine clone specification.

+
+
Return type
+

str

+
+
Returns
+

ID of newly-created virtual machine. +The return value will be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the specified name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec could not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to clone the virtual machine could +not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource Datastore referenced by the attribute +VM.DiskCloneSpec.datastore requires +Datastore.AllocateSpace.

    • +

  • The resource Datastore referenced by the attribute +VM.ClonePlacementSpec.datastore requires +Datastore.AllocateSpace.

    • +

  • The resource Folder referenced by the attribute +VM.ClonePlacementSpec.folder requires +VirtualMachine.Inventory.CreateFromExisting.

    • +

  • The resource ResourcePool referenced by the attribute +VM.ClonePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +

  • The resource VirtualMachine referenced by the attribute +VM.CloneSpec.source requires +VirtualMachine.Provisioning.Clone.

    • +
+
+
+
+ +
+
+clone_task(spec)
+

Creates a virtual machine from an existing virtual machine.

+

. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (VM.CloneSpec) – Virtual machine clone specification.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the specified name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec could not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to clone the virtual machine could +not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource Datastore referenced by the attribute +VM.DiskCloneSpec.datastore requires +Datastore.AllocateSpace.

    • +

  • The resource Datastore referenced by the attribute +VM.ClonePlacementSpec.datastore requires +Datastore.AllocateSpace.

    • +

  • The resource Folder referenced by the attribute +VM.ClonePlacementSpec.folder requires +VirtualMachine.Inventory.CreateFromExisting.

    • +

  • The resource ResourcePool referenced by the attribute +VM.ClonePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +

  • The resource VirtualMachine referenced by the attribute +VM.CloneSpec.source requires +VirtualMachine.Provisioning.Clone.

    • +
+
+
+
+ +
+
+create(spec)
+

Creates a virtual machine.

+
+
Parameters
+

spec (VM.CreateSpec) – Virtual machine specification.

+
+
Return type
+

str

+
+
Returns
+

ID of newly-created virtual machine. +The return value will be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the specified name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec could not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if any of the specified storage addresses (eg. IDE, SATA, SCSI, +NVMe) result in a storage address conflict.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to create the virtual machine could +not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if guestOS is not supported for the requested virtual hardware +version and spec includes None attributes that default to +guest-specific values.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource Folder referenced by the attribute +VM.InventoryPlacementSpec.folder requires +VirtualMachine.Inventory.Create.

    • +

  • The resource ResourcePool referenced by the attribute +VM.ComputePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +

  • The resource Datastore referenced by the attribute +VM.StoragePlacementSpec.datastore requires +Datastore.AllocateSpace.

    • +

  • The resource Network referenced by the attribute +com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec.network +requires Network.Assign.

    • +
+
+
+
+ +
+
+delete(vm)
+

Deletes a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is running (powered on).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Inventory.Delete.

    • +
+
+
+
+ +
+
+get(vm)
+

Returns information about a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

VM.Info

+
+
Returns
+

Information about the specified virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires System.Read.

    • +
+
+
+
+ +
+
+instant_clone(spec)
+

Create an instant clone of an existing virtual machine. This method was +added in vSphere API 6.7.1.

+
+
Parameters
+

spec (VM.InstantCloneSpec) – Virtual machine InstantCloneSpec.

+
+
Return type
+

str

+
+
Returns
+

ID of newly-created virtual machine. +The return value will be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the specified name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec could not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to create an instant clone could not +be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the attribute +VM.InstantCloneSpec.source requires +VirtualMachine.Provisioning.Clone and +VirtualMachine.Inventory.CreateFromExisting.

    • +

  • The resource Folder referenced by the attribute +VM.InstantClonePlacementSpec.folder requires +VirtualMachine.Interact.PowerOn.

    • +

  • The resource ResourcePool referenced by the attribute +VM.InstantClonePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +

  • The resource Datastore referenced by the attribute +VM.InstantClonePlacementSpec.datastore requires +Datastore.AllocateSpace.

    • +

  • The resource Network referenced by the attribute +com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec.network +requires Network.Assign.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 4000 visible (subject to permission +checks) virtual machines in vCenter matching the +VM.FilterSpec.

+
+
Parameters
+

filter (VM.FilterSpec or None) – Specification of matching virtual machines for which information +should be returned. +If None, the behavior is equivalent to a VM.FilterSpec +with all attributes None which means all virtual machines match the +filter.

+
+
Return type
+

list of VM.Summary

+
+
Returns
+

Commonly used information about the virtual machines matching the +VM.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the VM.FilterSpec.power_states attribute contains a +value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 4000 virtual machines match the +VM.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+register(spec)
+

Creates a virtual machine from existing virtual machine files on +storage. This method was added in vSphere API 6.8.7.

+
+
Parameters
+

spec (VM.RegisterSpec) – Specification of the location of the virtual machine files and the +placement of the new virtual machine.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly-created virtual machine. +The return value will be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the specified name already exists or if a +virtual machine using the specified virtual machine files already +exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec could not be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to register the virtual machine +could not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource Datastore referenced by the attribute +VM.RegisterSpec.datastore requires System.Read.

    • +

  • The resource Folder referenced by the attribute +VM.InventoryPlacementSpec.folder requires +VirtualMachine.Inventory.Register.

    • +

  • The resource ResourcePool referenced by the attribute +VM.ComputePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +
+
+
+
+ +
+
+relocate(vm, spec)
+

Relocates a virtual machine based on the specification. The parts of +the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, +CLUSTER and DATASTORE of home of the virtual machine and disks.

+

. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Existing Virtual machine to relocate. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (VM.RelocateSpec) – Relocate specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec or the given “vm” could +not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires Resource.ColdMigrate.

    • +

  • The resource ResourcePool referenced by the attribute +VM.RelocatePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +
+
+
+
+ +
+
+relocate_task(vm, spec)
+

Relocates a virtual machine based on the specification. The parts of +the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, +CLUSTER and DATASTORE of home of the virtual machine and disks.

+

. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Existing Virtual machine to relocate. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (VM.RelocateSpec) – Relocate specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any of the resources specified in spec or the given “vm” could +not be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if a specified resource (eg. host) is not accessible.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires Resource.ColdMigrate.

    • +

  • The resource ResourcePool referenced by the attribute +VM.RelocatePlacementSpec.resource_pool requires +Resource.AssignVMToPool.

    • +
+
+
+
+ +
+
+unregister(vm)
+

Removes the virtual machine corresponding to vm from the vCenter +inventory without removing any of the virtual machine’s files from +storage. All high-level information stored with the management server +(ESXi or vCenter) is removed, including information such as statistics, +resource pool association, permissions, and alarms. This method was +added in vSphere API 6.8.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine to be unregistered. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is running (powered on).

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no virtual machine associated with vm in the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Inventory.Unregister.

    • +
+
+
+
+ +
+ +
+
+

com.vmware.vstats_client module

+

The com.vmware.vstats_client component provides API classes and types used +in the vStats service.

+
+
+class com.vmware.vstats_client.AcqSpecs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AcqSpecs class provides methods to perform acquisition +specification related operations. An acquisition specification defines the +statistical data that should be collected at desired sampling rates from +the underlying providers. It designates the resources and their counters +which should be sampled, and a desired sampling rate. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CounterSpec(cid_mid=None, set_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AcqSpecs.CounterSpec class designates a counter or counter set in +an acquisition specification. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cid_mid (CidMid or None) – Counter and optional meatadata identifier. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When None the setId field will be used.

    • +

  • set_id (str or None) – Counter set identifier. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.CounterSet. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.CounterSet. +When None the cidMid field will be used.

    • +
+
+
+
+ +
+
+class CreateSpec(counters=None, resources=None, interval=None, expiration=None, memo_=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AcqSpecs.CreateSpec class contains information for a new data +acquisition specification. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • counters (AcqSpecs.CounterSpec) – Designates the counter(s) to be sampled. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • resources (list of RsrcId) – A set of resource identifiers representing a single resource to be +monitored. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • interval (long or None) – Desired sampling rate in seconds. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +If None default of 10s will be used.

    • +

  • expiration (long or None) – Expiration time for this acquisition specification in Unix UTC +number of seconds (since epoch). Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When this attribute is None or 0, default expiration duration is +100 minutes.

    • +

  • memo (str or None) – Consumer provided text about this acquisition specification. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +If None default empty string will be used.

    • +
+
+
+
+ +
+
+class FilterSpec(page=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AcqSpecs.FilterSpec class contains attributes used to filter the +results when listing acquisition specifications. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

page (str or None) – Used to retrieve paged data for larger result sets. The value of +this token is generated by server and returned as next +attribute in the result of list methods. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +None the first page of results will be returned.

+
+
+
+ +
+
+class Info(id=None, counters=None, resources=None, interval=None, expiration=None, memo_=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AcqSpecs.Info class is the information about an acquisition +specification. It specifies the statistical data that should be collected +at desired sampling rates. It designates the resources and their counters +which should be sampled, and a desired sampling rate. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Acquisition specification identifier. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.AcqSpec. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.AcqSpec.

    • +

  • counters (AcqSpecs.CounterSpec) – Designates the counter(s) to be sampled. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • resources (list of RsrcId) – A set of resource identifiers representing a single resource to be +monitored. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • interval (long or None) – Desired sampling rate in seconds. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When this attribute is None, default interval is 10 seconds.

    • +

  • expiration (long or None) – Expiration time for this acquisition specification represented as +Unix UTC number of seconds (since epoch). Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When this attribute is None or 0, default expiration duration is +100 minutes.

    • +

  • memo (str) – Consumer provided text about this Acquisition Specification. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • status (AcqSpecs.Status) – Acquisition Specification status. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+class ListResult(acq_specs=None, next=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AcqSpecs.ListResult class contains attributes used to return the +acquisition specifications. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • acq_specs (list of AcqSpecs.Info) – List of acquisition specifications received. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • next (str or None) – The next attribute is a token used to retrieve paged data for +larger result sets. This is opaque token generated by the server. +It is to be sent in the AcqSpecs.FilterSpec.page attribute +to issue a subsequent call to the list method for retrieving +results that did not fit the current page. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +set when there are more results to retrieve.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.AcqSpec'
+

Resource type for acquisition specifications. Warning: This class attribute +is available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Describes the status of an Acquisition Specification. Warning: This +enumeration is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+DISABLED = Status(string='DISABLED')
+

The acquisition specification is disabled when the stats data collection is +paused. This can happen when the counters are enabled or disabled +dynamically on providers. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+ENABLED = Status(string='ENABLED')
+

The acquisition specification is enabled when the stats data collection is +going on. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+EXPIRED = Status(string='EXPIRED')
+

The acquisition specification is expired when the expiration time is +exceeded. There is no data collection in that case. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+ +
+
+class UpdateSpec(counters=None, resources=None, interval=None, expiration=None, memo_=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AcqSpecs.UpdateSpec class contains attributes that can be updated +in an acquisition specification. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • counters (AcqSpecs.CounterSpec or None) – Designates the counter(s) to be sampled. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +If None, the value is unchanged.

    • +

  • resources (list of RsrcId or None) – A set of resource identifiers representing a single resource to be +monitored. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +If None, the value is unchanged.

    • +

  • interval (long or None) – Desired sampling rate in seconds. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +If None, the value is unchanged.

    • +

  • expiration (long or None) – Expiration time for this acquisition specification in Unix UTC +number of seconds (since epoch). When this attribute is 0, the +default expiration duration is 100 minutes. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +If None, the value is unchanged.

    • +

  • memo (str or None) – Consumer provided text about this Acquisition Specification. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+create(acq_spec)
+

Create a new acquisition specification record. Warning: This method +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

acq_spec (AcqSpecs.CreateSpec) – Specification for the acquisition of stats data.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly created acquisition specification. +The return value will be an identifier for the resource type: +com.vmware.vstats.model.AcqSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if acq_spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+delete(id)
+

Delete an acquisition specification. Warning: This method is +available as Technology Preview. These are early access APIs provided +to test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

id (str) – Acquisition specification ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.AcqSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if id is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if acquisition specification could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+get(id)
+

Returns information about a specific acquisition specification. +Warning: This method is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

id (str) – Acquisition specification ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.AcqSpec.

+
+
Return type
+

AcqSpecs.Info

+
+
Returns
+

Information about the desired acquisition specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if id is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +acquisition specification could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+list(filter=None)
+

Returns information about all acquisition specifications. Warning: +This method is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

filter (AcqSpecs.FilterSpec or None) – Criteria for selecting records to return. +When set filtering will be applied to the result.

+
+
Return type
+

AcqSpecs.ListResult

+
+
Returns
+

List of acquisition specification records.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+update(id, acq_spec)
+

Update an existing acquisition specification. Warning: This method +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+
    +

  • id (str) – Acquisition specification ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.AcqSpec.

    • +

  • acq_spec (AcqSpecs.UpdateSpec) – Updated acquisition specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +acquisition specification could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.CidMid(cid=None, mid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CidMid class is used to designate a counter. It contains a counter +id that identifies the semantical counter. There is optional metadata +identifier that identifies the particular generation of the counter. When +counter metadata is not designated vStats will use a default for the +counter metadata. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cid (str) – Counter Id. CID is a string with rather strong semantic consistency +across deployments and versions. If two CIDs are identical it +implies the corresponding counters are the same. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Counter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Counter.

    • +

  • mid (str or None) – MID is a 64-bit integer with strong consistency. Given a particular +CID=cid, if two MIDs are the same, then the corresponding +counter-metadata objects are same. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.CounterMetadata. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.CounterMetadata. +When this attribute is None vStats will use default for the counter +metadata as obtained from the provider.

    • +
+
+
+
+ +
+
+class com.vmware.vstats_client.CounterMetadata(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The CounterMetadata class provides access to the different historical +editions of counters. As computing platforms evolve over time the +measurement units for different characteristics of the systems change. As +such changes occur, counters will receive different editions reflected in a +new metadata record. For example computer memory had changes from kilobytes +through megabytes into gigabytes. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CounterEditionStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Counter metadata status. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CounterEditionStatus instance.

+
+
+
+
+CURRENT = CounterEditionStatus(string='CURRENT')
+

The counter edition is current. This implies a support commitment. +Warning: This class attribute is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+DEFAULT = CounterEditionStatus(string='DEFAULT')
+

The counter edition is current and is the default. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+DEPRECATED = CounterEditionStatus(string='DEPRECATED')
+

The counter edition is deprecated. It will be decommissioned rather soon. +Warning: This class attribute is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+EXPERIMENTAL = CounterEditionStatus(string='EXPERIMENTAL')
+

The counter edition is experimental. Consumers shouldn’t rely on it for the +long haul. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+REMOVED = CounterEditionStatus(string='REMOVED')
+

The counter edition was removed. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+ +
+
+class FilterSpec(status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CounterMetadata.FilterSpec class is used to filter the counter +metadata list. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

status (CounterMetadata.CounterEditionStatus or None) – Counter edition status. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When None no filtering on counter metadata status will be made.

+
+
+
+ +
+
+class Info(cid=None, mid=None, status=None, type=None, units=None, scale=None, user_info=None, pid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CounterMetadata.Info class contains information about +CounterMetadata. It represents edition of the Counter. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cid (str) – Counter Id. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Counter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Counter.

    • +

  • mid (str) – Metadata Id. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.CounterMetadata. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.CounterMetadata.

    • +

  • status (CounterMetadata.CounterEditionStatus) – Counter Edition status. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • type (CounterMetadata.SampleType) – Numeric properties of the sampled data. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • units (CounterMetadata.MetricUnits) – The units of the measurement. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • scale (CounterMetadata.UnitsFactor or None) – Additional multiplier factors to be used with units. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When None default of ONE is used.

    • +

  • user_info (UserInfo or None) – Human legible localizable text about the counter. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +This attribute is None in the current version.

    • +

  • pid (str or None) – ID of the respective provider. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Provider. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.Provider. +This attribute is None in the current version.

    • +
+
+
+
+ +
+
+class MetricUnits(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Unit used by a metric. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MetricUnits instance.

+
+
+
+
+AMPERE = MetricUnits(string='AMPERE')
+

Ampere. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+BIT = MetricUnits(string='BIT')
+

Bit. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+BITSPERSECOND = MetricUnits(string='BITSPERSECOND')
+

Bits per second. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+BYTE = MetricUnits(string='BYTE')
+

Byte. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+BYTESPERSECOND = MetricUnits(string='BYTESPERSECOND')
+

Bytes per second. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+CANDELA = MetricUnits(string='CANDELA')
+

Candela. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+CELSIUS = MetricUnits(string='CELSIUS')
+

Celsius. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+GRAM = MetricUnits(string='GRAM')
+

Gram. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+HERTZ = MetricUnits(string='HERTZ')
+

Hertz. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+JOULE = MetricUnits(string='JOULE')
+

Joule. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+KELVIN = MetricUnits(string='KELVIN')
+

Kelvin. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+KILOGRAM = MetricUnits(string='KILOGRAM')
+

Kilogram. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+METER = MetricUnits(string='METER')
+

Meter. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+METERSPERSECOND = MetricUnits(string='METERSPERSECOND')
+

Meters per second. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+METERSPERSECONDSQUARED = MetricUnits(string='METERSPERSECONDSQUARED')
+

Meters per second squared. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+MOLE = MetricUnits(string='MOLE')
+

Mole. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+NUMBER = MetricUnits(string='NUMBER')
+

Number. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+PERCENT = MetricUnits(string='PERCENT')
+

Percent. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+SECOND = MetricUnits(string='SECOND')
+

Second. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+VOLT = MetricUnits(string='VOLT')
+

Volt. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+VOLTAMPERE = MetricUnits(string='VOLTAMPERE')
+

Volt Ampere. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+WATT = MetricUnits(string='WATT')
+

Watt. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+ +
+
+class SampleType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Type of the sampled data. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SampleType instance.

+
+
+
+
+ABSOLUTE = SampleType(string='ABSOLUTE')
+

Absolute value samples. Represents an actual value of the counter. +Warning: This class attribute is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+DELTA = SampleType(string='DELTA')
+

Delta samples. Represents an amount of change for the counter between the +current time-stamp and the last time-stamp when the counter was sampled. +Warning: This class attribute is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+FRACTION = SampleType(string='FRACTION')
+

Fraction samples. Implies range from 0.00 to 1.00. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+LOGN = SampleType(string='LOGN')
+

Log(n) samples. A natural logarithm of the value. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+
+RATE = SampleType(string='RATE')
+

Rate samples. Represents a value that has been normalized over the time +period. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+RAW = SampleType(string='RAW')
+

Raw samples. The value unprocessed as-is sampled. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+ +
+ +
+
+class UnitsFactor(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Unit factor of measurement. Warning: This enumeration is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UnitsFactor instance.

+
+
+
+
+ATTO = UnitsFactor(string='ATTO')
+

Atto 10^-18. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+CENTI = UnitsFactor(string='CENTI')
+

Centi 10^-2. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+DECA = UnitsFactor(string='DECA')
+

Deca 10. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+DECI = UnitsFactor(string='DECI')
+

Deci 10^-1. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+EXA = UnitsFactor(string='EXA')
+

Exa 10^18. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+EXBI = UnitsFactor(string='EXBI')
+

Exbi 2^60, 1024^6. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+FEMTO = UnitsFactor(string='FEMTO')
+

Femto 10^-15. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+GIBI = UnitsFactor(string='GIBI')
+

Gibi 2^30, 1024^3. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+GIGA = UnitsFactor(string='GIGA')
+

Giga 10^9. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+HECTO = UnitsFactor(string='HECTO')
+

Hecto 10^2. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+KIBI = UnitsFactor(string='KIBI')
+

Kibi 2^10, 1024. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+KILO = UnitsFactor(string='KILO')
+

Kilo 10^3. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+MEBI = UnitsFactor(string='MEBI')
+

Mebi 2^20, 1024^2. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+MEGA = UnitsFactor(string='MEGA')
+

Mega 10^6. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+MICRO = UnitsFactor(string='MICRO')
+

Micro 10^-6. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+MILLI = UnitsFactor(string='MILLI')
+

Milli 10^-3. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+NANO = UnitsFactor(string='NANO')
+

Nano 10^-9. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+ONE = UnitsFactor(string='ONE')
+

One. Warning: This class attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+PEBI = UnitsFactor(string='PEBI')
+

Pebi 2^50, 1024^5. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+PETA = UnitsFactor(string='PETA')
+

Peta 10^15. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+PIKO = UnitsFactor(string='PIKO')
+

Pico 10^-12. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+TEBI = UnitsFactor(string='TEBI')
+

Tebi 2^40, 1024^4. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+TERA = UnitsFactor(string='TERA')
+

Tera 10^12. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+YOBI = UnitsFactor(string='YOBI')
+

Yobi 2^80, 1024^8. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+YOCTO = UnitsFactor(string='YOCTO')
+

Yocto 10^-24. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+YOTTA = UnitsFactor(string='YOTTA')
+

Yotta 10^24. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+ZEBI = UnitsFactor(string='ZEBI')
+

Zebi 2^70, 1024^7. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+ZEPTO = UnitsFactor(string='ZEPTO')
+

Zepto 10^-21. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+ZETTA = UnitsFactor(string='ZETTA')
+

Zetta 10^21. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+ +
+
+get(cid, mid)
+

Returns information about a specific CounterMetadata. Warning: This +method is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+
    +

  • cid (str) – Counter ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.Counter.

    • +

  • mid (str) – CounterMetadata ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.CounterMetadata.

    • +
+
+
Return type
+

CounterMetadata.Info

+
+
Returns
+

Information about the desired CounterMetadata.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Counter or CounterMetadata could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+get_default(cid)
+

This method returns the “default” CounterMetadata. A Counter has at +least one related metadata object. Usually, stats providers (for +example hosts) are in agreement about the default metadata. In this +case the returned list has a single metadata object.

+

Sometimes, when providers are in “disagreement” about the default, then +the returned list would include all the possible “defaults”. This +potential ambiguity isn’t a real issue because consumers of the vStats +API rarely need to specify the “mid” of metadata. Therefore, this API +is used primarily for informational purposes.. Warning: This method +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

cid (str) – Counter ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.Counter.

+
+
Return type
+

list of CounterMetadata.Info

+
+
Returns
+

List of counter metadata records.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if cid is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Counter could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+list(cid, filter=None)
+

Returns information about all counter metadata records for a specific +Counter. Warning: This method is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview +APIs might only be applicable to specific environments.

+
+
Parameters
+
    +

  • cid (str) – Counter ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.Counter.

    • +

  • filter (CounterMetadata.FilterSpec or None) – Filter specification. +When None no filtering will be performed.

    • +
+
+
Return type
+

list of CounterMetadata.Info

+
+
Returns
+

List of counter metadata for the specified counter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Counter could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.CounterSets(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The CounterSets class provides methods for accessing groupings of +counters. Counter-sets allow consumers to use groups of counters. The +counters may relate to different resource types. When an AcqSpecs +record refers to a counter-set, only the relevant counters apply. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(id=None, counters=None, user_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CounterSets.Info class contains information about a set of +counters. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Counter set identifier. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • counters (list of CidMid) – List of Counter CidMids. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • user_info (UserInfo or None) – Human legible localizable conter set description. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +In future versions it may be possible to have custom counter sets +that lack localizable descriptions.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.CounterSet'
+

Resource type for counter sets. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+get(counter_set)
+

Returns information about a specific counter set. Warning: This +method is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

counter_set (str) – identifier of the counter set to retrieve. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.CounterSet.

+
+
Return type
+

CounterSets.Info

+
+
Returns
+

Information about the desired CounterSet.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if counter_set is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the requested counter set could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+list()
+

Returns information about all the counter sets. Warning: This +method is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Return type
+

list of CounterSets.Info

+
+
Returns
+

List of counter sets.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.Counters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Counters class provides methods to perform various Counter related +operations. Counter is derived from metric. It applies the metric to a +particular class of a resource. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(cid=None, types=None, metric=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Counters.FilterSpec class contains fields that can be used to +filter list of counters. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cid (str or None) – Counter identifier that will be listed. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Counter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Counter. +If None counter filter will not be applied.

    • +

  • types (list of str or None) – Resource type filter. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vstats.model.RsrcType. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vstats.model.RsrcType. +If None resource type filter will not be applied.

    • +

  • metric (str or None) – Metric for which counters will be listed. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Metric. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Metric. +If None metric filter will not be applied.

    • +
+
+
+
+ +
+
+class Info(cid=None, metric=None, resource_address_schema=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Counters.Info class contains the counter information. Counter is +derived from metric. It applies the metric to a particular class of a +resource. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cid (str) – Counter Id. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Counter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Counter.

    • +

  • metric (str) – A metric is typically human-legible ASCII/English name of a +measurable aspect, for example “length” and “temperature”. It is +not internationalizable. Warning: This attribute is available +as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Metric. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Metric.

    • +

  • resource_address_schema (str) – Describes formally how to address (or identify) the resources the +counter could be bound to (or instantiated for). Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.RsrcAddrSchema. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.RsrcAddrSchema.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.Counter'
+

Resource type for counters. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+get(cid)
+

Returns information about a specific Counter. Warning: This method +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since +this can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

cid (str) – Counter ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.Counter.

+
+
Return type
+

Counters.Info

+
+
Returns
+

Information about the requested counter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if cid is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Counter could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+list(filter=None)
+

Returns information about all counters matching the filter parameters. +Warning: This method is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

filter (Counters.FilterSpec or None) – Filters the returned records. +When None no filtering will be applied.

+
+
Return type
+

list of Counters.Info

+
+
Returns
+

List of Counters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.Data(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Data class provides methods to query measurement and statistic +data. Warning: This class is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DataPoint(cid=None, mid=None, rid=None, ts=None, val=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Data.DataPoint class is an instance of a measurement or stat. A +data point is comprised of a Counter, CounterMetadata, Resource, timestamp +and value. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cid (str) – Counter Id. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Counter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Counter.

    • +

  • mid (str) – CounterMetadata Id. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.CounterMetadata. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.CounterMetadata.

    • +

  • rid (str) – Resource Id. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • ts (long) – Timestamp for the data point. format: 64-bit integer. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments.

    • +

  • val (float) – Stat value. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +
+
+
+
+ +
+
+class DataPointsResult(data_points=None, next=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Data.DataPointsResult class contains attributes used to return +DataPoints. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • data_points (list of Data.DataPoint) – List of DataPoints received. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • next (str or None) – The next attribute is a token used to retrieve paged data for +larger result sets. This is opaque token generated by the server. +It is to be sent in the Data.FilterSpec.page attribute to +issue a subsequent call to the query method for retrieving results +that did not fit the current page. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +set when there are more results to retrieve.

    • +
+
+
+
+ +
+
+class FilterSpec(start=None, end=None, cid=None, metric=None, types=None, resources=None, order=None, page=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Data.FilterSpec class contains attributes used to filter the +results when listing DataPoint. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • start (long or None) – Start of a time window (included), timestamp in seconds UTC. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When None the result will not be limited by start time.

    • +

  • end (long or None) – End of a time window (excluded), timestamp in seconds UTC. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When None the result will not be limited by end time.

    • +

  • cid (str or None) – Counter ID. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Counter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Counter. +When None the result will not be filtered by counter.

    • +

  • metric (str or None) – Metric name. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Metric. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Metric. +When None the result will not be filtered by metric name.

    • +

  • types (list of str or None) – List of Resource types. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vstats.model.RsrcType. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vstats.model.RsrcType. +When None the result will not be filtered by resource types.

    • +

  • resources (list of str or None) –

    Resources to include in the query. Each resource is specified +through a composite string that follows the following format.

    +

    type.<resource type>[.<scheme>]=<resource id>

    +

    resource type specifies the type of resource for example +VM, VCPU etc.

    +

    scheme is an optional element to disambiguate the resource as +needed for example to differentiate managed object id from +uuid.

    +

    resource id is the unique resource identifier value for +example: vm-41

    +

    Example values include: type.VM=vm-41, type.VCPU=1, +type.VM.moid=vm-41. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When left None the result will not be filtered for specific +resources.

    +

    • +

  • order (str or None) – Directs the server to order the returned data. Passing a value of +DEFAULT will apply default ordering of the results that makes +them easier for consumption. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When this parameter is None the server will not order the result, +save computational time and therefore the API will operate faster.

    • +

  • page (str or None) – Used to retrieve paged data for larger result sets. The value of +this token is generated by server and returned as next +attribute in the result of queryDataPoints methods. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When None the first page of results will be returned.

    • +
+
+
+
+ +
+
+query_data_points(filter=None)
+

Returns Data.DataPointsResult matching the filter parameters.

+

"/stats/data/dp?types=VM&types=VCPU"

+

"/stats/data/dp?rsrcs=type.HOST=host-16&rsrcs=type.VM=vm-31". +Warning: This method is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

filter (Data.FilterSpec or None) – Specification to match DataPoints. +When set filtering will be applied to the result.

+
+
Return type
+

Data.DataPointsResult

+
+
Returns
+

Data points matching the filter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.Metrics(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Metrics class provides method to list metrics. A metric is a +fundamental concept. It means a measurable aspect or property. For +instance, temperature, count, velocity, data size, bandwidth. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.Metric'
+

Resource type for metrics. Warning: This class attribute is available as +Technology Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+class Summary(metric=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Metrics.Summary class contains metric summary. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

metric (str) – Metric name. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Metric. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vstats.model.Metric.

+
+
+
+ +
+
+list()
+

Returns list of available Metrics as supplied by the discovered +providers. Warning: This method is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview +APIs might only be applicable to specific environments.

+
+
Return type
+

list of Metrics.Summary

+
+
Returns
+

List of Metrics.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.Providers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Providers class manages list of statistical data provider services +that are currently used. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.Provider'
+

Resource type for data providers. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+class Summary(id=None, id_value=None, type=None, scheme=None, metadata=None, tracking_sn=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Providers.Summary class describes a statistical data provider. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Provider identifier. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.Provider. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.Provider.

    • +

  • id_value (str) – The ID given to the provider by its respective inventory. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • type (str) – Provider type. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments.

    • +

  • scheme (str or None) – An optional designation of the scheme. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When None the provider is not designating a specific scheme.

    • +

  • metadata (str or None) – Schema-less metadata with extra information for the provider. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +As supplied by the provider.

    • +

  • tracking_sn (long or None) – Timestamp which is obtained when querying counters from a provider +and is used as since parameter when new counter listing is needed. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +{term unset} if no timestamp has been obtained yet.

    • +
+
+
+
+ +
+
+list()
+

Returns a list of stats providers. Warning: This method is +available as Technology Preview. These are early access APIs provided +to test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Return type
+

list of Providers.Summary

+
+
Returns
+

List of stats providers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.QueryPredicate(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The QueryPredicate enum describes how to query an id present in a +RsrcId. Warning: This enumeration is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the QueryPredicate instance.

+
+
+
+
+ALL = QueryPredicate(string='ALL')
+

Matching all available id-s. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+EQUAL = QueryPredicate(string='EQUAL')
+

Matching id-s by equality. Warning: This class attribute is available +as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based +on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+ +
+
+class com.vmware.vstats_client.ResourceAddressSchemas(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ResourceAddressSchemas class manages inventory of resource +addressing schemas used by Counters. Each schema consists of a +named list of resource identifiers of specific resource type. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(id=None, schema=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAddressSchemas.Info class defines addressing schema for a +counter. This is set of named placeholders for different resource types. +For example a network link between VMs will take two arguments “source” and +“destination” both of type VM. For each argument query capability is +defined. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Identifier. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.RsrcAddrSchema. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.RsrcAddrSchema.

    • +

  • schema (list of ResourceAddressSchemas.ResourceIdDefinition) – List of :class:`ResourceAddressSchemas.ResourceIdDefinition`s. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +
+
+
+
+ +
+
+class QueryCapabilities(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Declares which predicates are supported by the +ResourceAddressSchemas.ResourceIdDefinition. Warning: This +enumeration is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the QueryCapabilities instance.

+
+
+
+
+EQUAL = QueryCapabilities(string='EQUAL')
+

Equal. Warning: This class attribute is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+ +
+
+EQUAL_ALL = QueryCapabilities(string='EQUAL_ALL')
+

Supports both Equality and Aggregation. Warning: This class attribute +is available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+ +
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.RsrcAddrSchema'
+

Resource type for resource addressing schemas. Warning: This class +attribute is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+ +
+
+class ResourceIdDefinition(key=None, type=None, query_options=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAddressSchemas.ResourceIdDefinition class describes a +single identifier of the Resource Addressing Schema. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (str) – Designates a semantic key for the resource identifier. This could +be “vm” for virtual machine whose CPU usage is metered or “source” +to identify the virtual machine that is origin of measured network +traffic. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • type (str) – Type of the resource. This represents various entities for which +statistical data is gathered such as virtual machines, containers, +servers, disks etc. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.RsrcType. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.RsrcType.

    • +

  • query_options (ResourceAddressSchemas.QueryCapabilities) – Designates the supported query-options. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+get(id)
+

Returns information about a specific resource address schema. +Warning: This method is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

id (str) – Resource address schema identifier.

+
+
Return type
+

ResourceAddressSchemas.Info

+
+
Returns
+

Information about the desired resource address schema.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if id is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if RsrcAddrSchema could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.ResourceAddresses(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ResourceAddresses class provides methods to perform resource +addressing queries. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(types=None, resources=None, page=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ResourceAddresses.FilterSpec class describes filter criteria for +resource addresses. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • types (list of str or None) – List of Resource types. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vstats.model.RsrcType. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vstats.model.RsrcType. +When None the result will not be filtered by resource types.

    • +

  • resources (list of str or None) –

    Resources to include in the query. Each resource is specified +through a composite string that follows the following format.

    +

    type.<resource type>[.<scheme>]=<resource id>

    +

    resource type specifies the type of resource for example +VM, VCPU etc.

    +

    scheme is an optional element to disambiguate the resource as +needed for example to differentiate managed object id from +uuid.

    +

    resource id is the unique resource identifier value for +example: vm-41

    +

    Example values include: type.VM=vm-41, type.VCPU=1, +type.VM.moid=vm-41. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When left None the result will not be filtered for specific +resources.

    +

    • +

  • page (str or None) – The page field is used to retrieve paged data for large result +sets. It is an opaque paging token obtained from a prior call to +the ResourceAddresses.list() API. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +when set a follow up page in a paged result set will be +delivered.

    • +
+
+
+
+ +
+
+class Info(id=None, resource_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAddresses.Info class contains global address of a specific +Resource. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Identifier. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.RsrcAddr. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.RsrcAddr.

    • +

  • resource_ids (list of RsrcId) – List of Resource Identifiers. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+class ListResult(rsrc_addrs=None, next=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAddresses.ListResult class contains attributes used to +return the resource addresses. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • rsrc_addrs (list of ResourceAddresses.Info) – List of Resource Addresses received. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +

  • next (str or None) – Used to retrieve paged data for larger result sets. Token is +generated by server. The value of this field should be supplied in +a subsequent call to ResourceAddresses.list() method. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +None when there are no more pages of data to be retrieved.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.RsrcAddr'
+

Resource type for ResourceAddresses. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+get(id)
+

Returns information about a specific Resource Address. Warning: +This method is available as Technology Preview. These are early access +APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Parameters
+

id (str) – Resource Address ID. +The parameter must be an identifier for the resource type: +com.vmware.vstats.model.RsrcAddr.

+
+
Return type
+

ResourceAddresses.Info

+
+
Returns
+

Information about the desired Resource Address.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if id is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Resource Address could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+
+list(filter=None)
+

Returns the list of Resource Addresses matching the filter parameters. +Warning: This method is available as Technology Preview. These are +early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+
Parameters
+

filter (ResourceAddresses.FilterSpec or None) – Criteria for selecting records to return. +If None all records will be returned.

+
+
Return type
+

ResourceAddresses.ListResult

+
+
Returns
+

Matching resource addresses.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.ResourceTypes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ResourceTypes class provides list of resource types. Resource +refers to any item or concept that could have measurable properties. It is +a prerequisite that a resource can be identified.

+

Example resource types are virtual machine, virtual disk etc.. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vstats.model.RsrcType'
+

Resource type for resource types. Warning: This class attribute is +available as Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+ +
+
+class Summary(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceTypes.Summary class contains information of addressable +resource. Warning: This class is available as Technology Preview. These +are early access APIs provided to test, automate and provide feedback on +the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (str) – Resource type. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vstats.model.RsrcType. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vstats.model.RsrcType.

+
+
+
+ +
+
+list()
+

Returns a list of available resource types. Warning: This method is +available as Technology Preview. These are early access APIs provided +to test, automate and provide feedback on the feature. Since this can +change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+
Return type
+

list of ResourceTypes.Summary

+
+
Returns
+

List of resource types.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have sufficient privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vstats_client.RsrcId(key=None, type=None, id_value=None, predicate=None, scheme=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The RsrcId class specifies identification of a resource to be monitored +by an acquisition specification record. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (str or None) – Key relates to the corresponding ResourceIdDefinition of the +related resource address schema. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When this attribute is None, type attribute will be used.

    • +

  • type (str or None) – Type of the resource identified by the Resource Id. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When this attribute is None, in current version the api will throw +InvalidArgument error. To be made optional in future.

    • +

  • id_value (str) – The id value binding the related resource id definition. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

    • +

  • predicate (QueryPredicate or None) – Predicate to use to match resource Ids. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When this attribute is None, default predicate is EQUAL.

    • +

  • scheme (str or None) – An optional designation of the scheme. Warning: This attribute +is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When this attribute is None, default scheme is moid (ManagedObject +Identifier).

    • +
+
+
+
+ +
+
+class com.vmware.vstats_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vstats_client.UserInfo(label=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UserInfo class contains human legible, localizable description, +used for VMware provided objects. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (com.vmware.vapi.std_client.LocalizableMessage) – Short label. Warning: This attribute is available as Technology +Preview. These are early access APIs provided to test, automate and +provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some +Technology Preview APIs might only be applicable to specific +environments.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Detailed description of the object. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.oauth2.html b/vsphere/8.0.2.0/com.vmware.oauth2.html new file mode 100644 index 00000000..6eef4b32 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.oauth2.html @@ -0,0 +1,315 @@ + + + + + + + com.vmware.oauth2 package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.oauth2 package

+
+

Submodules

+
+
+

com.vmware.oauth2.errors_client module

+

The com.vmware.oauth2.errors_client module provides the OAuth 2.0 +exceptions that can be included in the list of exceptions in the specification +of OAuth 2.0 methods to indicate that the method might report those exceptions.

+
+
+exception com.vmware.oauth2.errors_client.Error(error=None, error_description=None, error_uri=None)
+

Bases: vmware.vapi.bindings.error.VapiError

+

The OAuth2 Error describes the attributes common to standard OAuth 2.0 +exceptions.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • error (Error.Type) – Discriminator field to help API consumers identify the structure +type.

    • +

  • error_description (str or None) – Human-readable ASCII text providing additional information, used to +assist the client developer in understanding the error that +occurred. Values for the “error_description” parameter MUST NOT +include characters outside the set %x20-21 / %x23-5B / %x5D-7E. +if no additional information is available.

    • +

  • error_uri (str or None) – A URI identifying a human-readable web page with information about +the error, used to provide the client developer with additional +information about the error. +if no such web-page is available.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Enumeration of OAuth 2.0 exceptions.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+invalid_grant = Type(string='invalid_grant')
+

Discriminator for the InvalidGrant type.

+
+ +
+
+invalid_request = Type(string='invalid_request')
+

Discriminator for the InvalidRequest type.

+
+ +
+
+invalid_scope = Type(string='invalid_scope')
+

Discriminator for the InvalidScope type.

+
+ +
+ +
+ +
+
+exception com.vmware.oauth2.errors_client.InvalidGrant(error='INVALID_GRANT', error_description=None, error_uri=None)
+

Bases: com.vmware.oauth2.errors_client.Error

+

Indicates that the provided authorization grant (e.g., authorization code, +resource owner credentials) or refresh token is invalid, expired, revoked, +does not match the redirection URI used in the authorization request, or +was issued to another client.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • error (Error.Type) – Discriminator field to help API consumers identify the structure +type.

    • +

  • error_description (str or None) – Human-readable ASCII text providing additional information, used to +assist the client developer in understanding the error that +occurred. Values for the “error_description” parameter MUST NOT +include characters outside the set %x20-21 / %x23-5B / %x5D-7E. +if no additional information is available.

    • +

  • error_uri (str or None) – A URI identifying a human-readable web page with information about +the error, used to provide the client developer with additional +information about the error. +if no such web-page is available.

    • +
+
+
+
+ +
+
+exception com.vmware.oauth2.errors_client.InvalidRequest(error='INVALID_REQUEST', error_description=None, error_uri=None)
+

Bases: com.vmware.oauth2.errors_client.Error

+

Indicates that the request is missing a required parameter, includes an +unsupported parameter value (other than grant type), repeats a parameter, +includes multiple credentials, utilizes more than one mechanism for +authenticating the client, or is otherwise malformed

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • error (Error.Type) – Discriminator field to help API consumers identify the structure +type.

    • +

  • error_description (str or None) – Human-readable ASCII text providing additional information, used to +assist the client developer in understanding the error that +occurred. Values for the “error_description” parameter MUST NOT +include characters outside the set %x20-21 / %x23-5B / %x5D-7E. +if no additional information is available.

    • +

  • error_uri (str or None) – A URI identifying a human-readable web page with information about +the error, used to provide the client developer with additional +information about the error. +if no such web-page is available.

    • +
+
+
+
+ +
+
+exception com.vmware.oauth2.errors_client.InvalidScope(error='INVALID_SCOPE', error_description=None, error_uri=None)
+

Bases: com.vmware.oauth2.errors_client.Error

+

Indicates that the requested scope is invalid, unknown, malformed, or +exceeds the scope granted by the resource owner.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • error (Error.Type) – Discriminator field to help API consumers identify the structure +type.

    • +

  • error_description (str or None) – Human-readable ASCII text providing additional information, used to +assist the client developer in understanding the error that +occurred. Values for the “error_description” parameter MUST NOT +include characters outside the set %x20-21 / %x23-5B / %x5D-7E. +if no additional information is available.

    • +

  • error_uri (str or None) – A URI identifying a human-readable web page with information about +the error, used to provide the client developer with additional +information about the error. +if no such web-page is available.

    • +
+
+
+
+ +
+
+class com.vmware.oauth2.errors_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vapi.html b/vsphere/8.0.2.0/com.vmware.vapi.html new file mode 100644 index 00000000..8d095bb3 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vapi.html @@ -0,0 +1,722 @@ + + + + + + + com.vmware.vapi package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vapi package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vapi.metadata_client module

+

The com.vmware.vapi.metadata_client module provides metadata classes. +These are classes that provide different facets of API information. Clients can +use these classes to:

+
    +

  • Discover APIs available in the infrastructure.

    • +

  • Fetch metadata that can be used to build presentation layers like CLI, REST, +etc.

    • +

  • Fetch authentication and authorization metadata.

    • +
+
+
+class com.vmware.vapi.metadata_client.SourceCreateSpec(description=None, type=None, filepath=None, address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SourceCreateSpec class contains the registration information for a +metadata source.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – English language human readable description of the source.

    • +

  • type (SourceType) – Type of the metadata source.

    • +

  • filepath (str) – Absolute file path of the metamodel metadata file that has the +metamodel information about one component element. +This attribute is optional and it is only relevant when the value +of type is SourceType.FILE.

    • +

  • address (str) –

    Connection information of the remote server. This should be of the +format http(s)://IP:port/namespace.

    +

    The remote server should contain the classes in +com.vmware.vapi.metadata.metamodel_client module. It could +expose metamodel information of one or more components. +This attribute is optional and it is only relevant when the value +of type is SourceType.REMOTE.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata_client.SourceInfo(type=None, file_name=None, remote_addr=None, msg_protocol=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Metadata source info

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (SourceType) – Type of the metadata source

    • +

  • file_name (str) – Name of the metadata source file +This attribute is optional and it is only relevant when the value +of type is SourceType.FILE.

    • +

  • remote_addr (str) – Address of the remote metadata source +This attribute is optional and it is only relevant when the value +of type is SourceType.REMOTE.

    • +

  • msg_protocol (str) – Message protocol to be used +This attribute is optional and it is only relevant when the value +of type is SourceType.REMOTE.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata_client.SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SourceType class defines the types of sources for API metadata. You +specify the type of source when adding a metadata source to a metadata +service.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+FILE = SourceType(string='FILE')
+

Indicates the metadata source is a JSON file.

+
+ +
+
+REMOTE = SourceType(string='REMOTE')
+

Indicates the metadata source is a remote server.

+
+ +
+ +
+
+class com.vmware.vapi.metadata_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vapi.std_client module

+

The com.vmware.vapi.std_client module provides standard types that can be +used in the interface specification of any class.

+
+
+class com.vmware.vapi.std_client.AuthenticationScheme
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuthenticationScheme class defines constants for +authentication scheme identifiers for authentication mechanisms present in +the vAPI infrastructure shipped by VMware.

+

A third party extension can define and implements it’s own authentication +mechanism and define a constant in a different IDL file.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
+NO_AUTHENTICATION = 'com.vmware.vapi.std.security.no_authentication'
+

Indicates that the request doesn’t need any authentication.

+
+ +
+
+OAUTH_ACCESS_TOKEN = 'com.vmware.vapi.std.security.oauth'
+

Indicates that the security context in a request is using OAuth2 based +authentication scheme.

+

In this scheme, the following pieces of information has to be passed in the +SecurityContext structure in the execution context of the request:

+
    +

  • The scheme identifier - com.vmware.vapi.std.security.oauth

    • +

  • Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization +Server after successful authentication of the end user.

    • +
+

Sample security context in JSON format that matches the specification: { +'schemeId': 'com.vmware.vapi.std.security.oauth', +'accesstoken': .... +} +vAPI runtime provides convenient factory methods that takes OAuth2 access token +as input parameter and creates a security context that conforms to the above +format.

+
+ +
+
+SAML_BEARER_TOKEN = 'com.vmware.vapi.std.security.saml_bearer_token'
+

Indicates that the security context in a request is using a SAML bearer token +based authentication scheme.

+

In this scheme, the following pieces of information has to be passed in the +SecurityContext structure in the execution context of the request:

+
    +

  • The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token

    • +

  • The token itself

    • +
+

Sample security context in JSON format that matches the specification: { +'schemeId': 'com.vmware.vapi.std.security.saml_bearer_token', +'token': 'the token itself' +} vAPI runtime provide convenient factory methods that take SAML bearer token +and to create the security context that conforms to the above mentioned format.

+
+ +
+
+SAML_HOK_TOKEN = 'com.vmware.vapi.std.security.saml_hok_token'
+

Indicates that the security context in a request is using a SAML holder-of-key +token based authentication scheme.

+

In this scheme, the following pieces of information has to be passed in the +SecurityContext structure in the execution context of the request:

+
    +

  • The scheme identifier: com.vmware.vapi.std.security.saml_hok_token

    • +

  • Signature of the request: This includes - algorithm used for signing the +request, SAML holder of key token and signature digest

    • +

  • Request timestamp: This includes the created and expires timestamp of +the request. The timestamp should match the following format - +YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).

    • +
+

Sample security context in JSON format that matches the specification: { +'schemeId': 'com.vmware.vapi.std.security.saml_hok_token', +'signature': { +'alg': 'RS256', +'samlToken': ..., +'value': ...,, ‘timestamp’: { ‘created’: ‘2012-10-26T12:24:18.941Z’, +‘expires’: ‘2012-10-26T12:44:18.941Z’, } } } vAPI runtime provide convenient +factory methods that take SAML holder of key token and private key to create +the security context that conforms to the above mentioned format.

+
+ +
+
+SESSION_ID = 'com.vmware.vapi.std.security.session_id'
+

Indicates that the security context in a request is using a session identifier +based authentication scheme.

+

In this scheme, the following pieces of information has to be passed in the +SecurityContext structure in the execution context of the request:

+
    +

  • The scheme identifier - com.vmware.vapi.std.security.session_id

    • +

  • Valid session identifier - This is usually returned by a login method of a +session manager interface for a particular vAPI service of this authentication +scheme

    • +
+

Sample security context in JSON format that matches the specification: { +'schemeId': 'com.vmware.vapi.std.security.session_id', +'sessionId': ...., +} vAPI runtime provides convenient factory methods that take session +identifier as input parameter and create a security context that conforms to +the above format.

+
+ +
+
+USER_PASSWORD = 'com.vmware.vapi.std.security.user_pass'
+

Indicates that the security context in a request is using username/password +based authentication scheme.

+

In this scheme, the following pieces of information has to be passed in the +SecurityContext structure in the execution context of the request:

+
    +

  • The scheme identifier - com.vmware.vapi.std.security.user_pass

    • +

  • Username

    • +

  • Password

    • +
+

Sample security context in JSON format that matches the specification: { +'schemeId': 'com.vmware.vapi.std.security.user_pass', +'userName': ...., +'password': ... +} +vAPI runtime provides convenient factory methods that take username and +password as input parameters and create a security context that conforms to the +above format.

+
+ +
+ +
+
+class com.vmware.vapi.std_client.DynamicID(type=None, id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DynamicID class represents an identifier for a resource of an +arbitrary type.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (str) –

    The type of resource being identified (for example +com.acme.Person).

    +

    Classes that contain methods for creating and deleting resources +typically contain a class attribute specifying the resource type +for the resources being created and deleted. The API metamodel +metadata classes include a class that allows retrieving all the +known resource types.

    +

    • +

  • id (str) – The identifier for a resource whose type is specified by +DynamicID.type. +When clients pass a value of this class as a parameter, the +attribute type must contain the actual resource type. When +methods return a value of this class as a return value, the +attribute type will contain the actual resource type.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std_client.LocalizableMessage(id=None, default_message=None, args=None, params=None, localized=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalizableMessage class represents localizable string and message +template. Classes include one or more localizable message templates in the +exceptions they report so that clients can display diagnostic messages in +the native language of the user. Classes can include localizable strings in +the data returned from methods to allow clients to display localized status +information in the native language of the user.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) –

    Unique identifier of the localizable string or message template.

    +

    This identifier is typically used to retrieve a locale-specific +string or message template from a message catalog.

    +

    • +

  • default_message (str) – The value of this localizable string or message template in the +en_US (English) locale. If LocalizableMessage.id refers +to a message template, the default message will contain the +substituted arguments. This value can be used by clients that do +not need to display strings and messages in the native language of +the user. It could also be used as a fallback if a client is unable +to access the appropriate message catalog.

    • +

  • args (list of str) – Positional arguments to be substituted into the message template. +This list will be empty if the message uses named arguments or has +no arguments.

    • +

  • params ((dict of str and LocalizationParam) or None) – Named arguments to be substituted into the message template. This +attribute was added in vSphere API 7.0.0.0. +None means that the message template requires no arguments or +positional arguments are used.

    • +

  • localized (str or None) – Localized string value as per request requirements. This attribute +was added in vSphere API 7.0.0.0. +when the client has not requested specific locale the +implementation may not populate this field to conserve resources.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std_client.LocalizationParam(s=None, dt=None, i=None, d=None, l=None, format=None, precision=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This class holds a single message parameter and formatting settings for it. +The class has fields for str, int, +decimal.Decimal, date time and nested messages. Only one will be +used depending on the type of data sent. For date, decimal.Decimal +and int it is possible to set additional formatting details. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • s (str or None) – str value associated with the parameter. This attribute +was added in vSphere API 7.0.0.0. +this attribute will be set when str value is used.

    • +

  • dt (datetime.datetime or None) – Date and time value associated with the parameter. Use the +format attribute to specify date and time display style. This +attribute was added in vSphere API 7.0.0.0. +this attribute will be set when date and time value is used.

    • +

  • i (long or None) – int value associated with the parameter. This attribute +was added in vSphere API 7.0.0.0. +this attribute will be set when int value is used.

    • +

  • d (float or None) – The decimal.Decimal value associated with the parameter. +The number of displayed fractional digits is changed via +precision attribute. This attribute was added in vSphere API +7.0.0.0. +this attribute will be set when decimal.Decimal value is +used.

    • +

  • l (NestedLocalizableMessage or None) – Nested localizable value associated with the parameter. This is +useful construct to convert to human readable localized form class +and bool values. It can also be used for proper handling +of pluralization and gender forms in localization. Recursive +NestedLocalizableMessage instances can be used for localizing +short lists of items. This attribute was added in vSphere API +7.0.0.0. +this attribute will be set when nested localization message value +is used.

    • +

  • format (LocalizationParam.DateTimeFormat or None) – Format associated with the date and time value in dt attribute. +The class attribute SHORT_DATETIME will be used as default. +This attribute was added in vSphere API 7.0.0.0. +this may not be set if class attribute SHORT_DATETIME default +format is appropriate

    • +

  • precision (long or None) – Number of fractional digits to include in formatted +decimal.Decimal value. This attribute was added in vSphere +API 7.0.0.0. +this will be set when exact precision is required for rendering +decimal.Decimal numbers.

    • +
+
+
+
+
+class DateTimeFormat(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LocalizationParam.DateTimeFormat class lists possible date and time +formatting options. It combines the Unicode CLDR format types - full, long, +medium and short with 3 different presentations - date only, time only and +combined date and time presentation. This enumeration was added in vSphere +API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DateTimeFormat instance.

+
+
+
+
+FULL_DATE = DateTimeFormat(string='FULL_DATE')
+

The date and time value will be formatted as full date, for example 2019 +Jan 28, Mon. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+FULL_DATE_TIME = DateTimeFormat(string='FULL_DATE_TIME')
+

The date and time value will be formatted as full date and time, for +example 2019 Jan 28, Mon 12:59:01 Z. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+FULL_TIME = DateTimeFormat(string='FULL_TIME')
+

The date and time value will be formatted as full time, for example +12:59:01 Z. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+LONG_DATE = DateTimeFormat(string='LONG_DATE')
+

The date and time value will be formatted as long date, for example 2019 +Jan 28. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+LONG_DATE_TIME = DateTimeFormat(string='LONG_DATE_TIME')
+

The date and time value will be formatted as long date and time, for +example 2019 Jan 28 12:59:01 Z. This class attribute was added in vSphere +API 7.0.0.0.

+
+ +
+
+LONG_TIME = DateTimeFormat(string='LONG_TIME')
+

The date and time value will be formatted as long time, for example +12:59:01 Z. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+MED_DATE = DateTimeFormat(string='MED_DATE')
+

The date and time value will be formatted as medium date, for example 2019 +Jan 28. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+MED_DATE_TIME = DateTimeFormat(string='MED_DATE_TIME')
+

The date and time value will be formatted as medium date and time, for +example 2019 Jan 28 12:59:01. This class attribute was added in vSphere +API 7.0.0.0.

+
+ +
+
+MED_TIME = DateTimeFormat(string='MED_TIME')
+

The date and time value will be formatted as medium time, for example +12:59:01. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SHORT_DATE = DateTimeFormat(string='SHORT_DATE')
+

The date and time value will be formatted as short date, for example +2019-01-28. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SHORT_DATE_TIME = DateTimeFormat(string='SHORT_DATE_TIME')
+

The date and time value will be formatted as short date and time, for +example 2019-01-28 12:59. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+SHORT_TIME = DateTimeFormat(string='SHORT_TIME')
+

The date and time value will be formatted as short time, for example +12:59. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.std_client.NestedLocalizableMessage(id=None, params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NestedLocalizableMessage class represents a nested within a +parameter localizable string or message template. This class is useful for +modeling composite messages. Such messages are necessary to do correct +pluralization of phrases, represent lists of several items etc. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) –

    Unique identifier of the localizable string or message template.

    +

    This identifier is typically used to retrieve a locale-specific +string or message template from a message catalog.. This attribute +was added in vSphere API 7.0.0.0.

    +

    • +

  • params ((dict of str and LocalizationParam) or None) – Named Arguments to be substituted into the message template. This +attribute was added in vSphere API 7.0.0.0. +services will not populate this field when there are no parameters +to be substituted

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vapi.metadata.authentication.html b/vsphere/8.0.2.0/com.vmware.vapi.metadata.authentication.html new file mode 100644 index 00000000..d4907727 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vapi.metadata.authentication.html @@ -0,0 +1,245 @@ + + + + + + + com.vmware.vapi.metadata.authentication package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vapi.metadata.authentication package

+
+

Submodules

+
+
+

com.vmware.vapi.metadata.authentication.service_client module

+

The com.vmware.vapi.metadata.authentication.service_client module provides +classes to retrieve authentication information for operation elements.

+
+
+class com.vmware.vapi.metadata.authentication.service_client.Operation(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Operation class provides methods to retrieve authentication +information of an operation element.

+

An operation element is said to contain authentication information if +authentication schemes are specified in the authentication definition file.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.operation'
+

Resource type for operation.

+
+ +
+
+get(service_id, operation_id)
+

Retrieves the authentication information about an operation element +corresponding to operation_id contained in the service element +corresponding to service_id.

+
+
Parameters
+
    +

  • service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

    • +

  • operation_id (str) – Identifier of the operation element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.operation.

    • +
+
+
Return type
+

com.vmware.vapi.metadata.authentication_client.OperationInfo

+
+
Returns
+

The +com.vmware.vapi.metadata.authentication_client.OperationInfo +instance that corresponds to operation_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the operation element associated with operation_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the operation element associated with operation_id does not +have any authentication information.

+
+
+
+ +
+
+list(service_id)
+

Returns the identifiers for the operation elements contained in the +service element corresponding to service_id that have +authentication information.

+
+
Parameters
+

service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

+
+
Return type
+

list of str

+
+
Returns
+

List of identifiers for the operation elements contained in the +service element that have authentication information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not have +any operation elements that have authentication information.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.authentication.service_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vapi.metadata.html b/vsphere/8.0.2.0/com.vmware.vapi.metadata.html new file mode 100644 index 00000000..7edf37f8 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vapi.metadata.html @@ -0,0 +1,3301 @@ + + + + + + + com.vmware.vapi.metadata package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vapi.metadata package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vapi.metadata.authentication_client module

+

The com.vmware.vapi.metadata.authentication_client module provides classes +that expose authentication information for operation elements across all the +service elements.

+

To calculate the effective authentication information for an operation element, +you should first see if there is an authentication scheme specified for the +operation element. If it is not specified, then authentication scheme for the +service element that contains this operation element is used. If it is not +specified for the service element as well, then the authentication scheme for +the package element that contains this service element is used.

+
+
+class com.vmware.vapi.metadata.authentication_client.AuthenticationInfo(scheme_type=None, session_manager=None, scheme=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AuthenticationInfo class describes the authentication information. +Authentication information could be specified for a package element, +service elenent or an operation element.

+

Using the authentication scheme information, a client invoking an API call +from any class can figure out what kind of credentials are needed for that +API call.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • scheme_type (AuthenticationInfo.SchemeType) – The type of the authentication scheme.

    • +

  • session_manager (str) – In a session aware authentication scheme, a session manager is +required that supports create, delete and keepAlive +methods. The fully qualified class name of the session manager is +provided in AuthenticationInfo.session_manager attribute. +This class is responsible for handling sessions. +This attribute is optional and it is only relevant when the value +of schemeType is +AuthenticationInfo.SchemeType.SESSION_AWARE.

    • +

  • scheme (str) –

    String identifier of the authentication scheme.

    +

    Following are the supported authentication schemes by the +infrastructure:

    +
      +

    • The identifier com.vmware.vapi.std.security.saml_hok_token +for SAML holder of key token based authentication mechanism.

      • +

    • The identifier com.vmware.vapi.std.security.bearer_token for +SAML bearer token based authentication mechanism.

      • +

    • The identifier com.vmware.vapi.std.security.session_id for +session based authentication mechanism.

      • +

    • The identifier com.vmware.vapi.std.security.user_pass for +username and password based authentication mechanism.

      • +
    +

    • +
+
+
+
+
+class SchemeType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The AuthenticationInfo.SchemeType class provides class attributes for +the set of valid authentication scheme types.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SchemeType instance.

+
+
+
+
+SESSIONLESS = SchemeType(string='SESSIONLESS')
+

Indicates that the scheme is a session less authentication scheme, the user +is authenticated on every method. There is no explicit session +establishment.

+
+ +
+
+SESSION_AWARE = SchemeType(string='SESSION_AWARE')
+

Indicates that the scheme is a session aware authentication scheme. It +requires an explicit login before executing a method and logout when a +session terminates. A class might choose to have a session aware scheme if +it wants to associate some state corresponding to the user until the user +logs out or if it wants to mitigate the cost of authenticating the user on +every method.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.authentication_client.Component(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Component class provides methods to retrieve authentication +information of a component element.

+

A component element is said to contain authentication information if any +one of package elements contained in it has authentication information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.component'
+

Resource type for component.

+
+ +
+
+fingerprint(component_id)
+

Retrieves the fingerprint computed from the authentication metadata of +the component element corresponding to component_id.

+

The fingerprint provides clients an efficient way to check if the +metadata for a particular component has been modified on the server. +The client can do this by comparing the result of this operation with +the fingerprint returned in the result of Component.get().

+
+
Parameters
+

component_id (str) – Identifier of the component element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.component.

+
+
Return type
+

str

+
+
Returns
+

The fingerprint computed from the authentication metadata of the +component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the component element associated with component_id does not +have any authentication information.

+
+
+
+ +
+
+get(component_id)
+

Retrieves authentication information about the component element +corresponding to component_id.

+

The ComponentData contains the authentication information +about the component element and it’s fingerprint. It contains +information about all the package elements that belong to this +component element.

+
+
Parameters
+

component_id (str) – Identifier of the component element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.component.

+
+
Return type
+

ComponentData

+
+
Returns
+

The ComponentData instance that corresponds to +component_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the component element associated with component_id does not +have any authentication information.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the component elements that have +authentication information.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the component elements that have +authentication information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.component.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.authentication_client.ComponentData(info=None, fingerprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentData class contains the authentication information of the +component along with its fingerprint.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (ComponentInfo) – Authentication information of the component. This includes +information about all the modules in the component.

    • +

  • fingerprint (str) –

    Fingerprint of the metadata of the component.

    +

    Authentication information could change when there is an +infrastructure update. Since the data present in +ComponentData.info could be quite large, fingerprint +provides a convenient way to check if the data for a particular +component is updated.

    +

    You should store the fingerprint associated with a component. After +an update, by invoking the Component.fingerprint() method, +you can retrieve the new fingerprint for the component. If the new +fingerprint and the previously stored fingerprint do not match, +clients can then use the Component.get() to retrieve the new +authentication information for the component.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.authentication_client.ComponentInfo(packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentInfo class contains authentication information of a +component element.

+

For an explanation of authentication information contained within component +elements, see Component.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

packages (dict of str and PackageInfo) –

Authentication information of all the package elements. The key in +the dict is the identifier of the package element and the +value in the dict is the authentication information for +the package element.

+

For an explanation of authentication information containment within +package elements, see Package. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.package. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.package.

+

+
+
+
+ +
+
+class com.vmware.vapi.metadata.authentication_client.OperationInfo(schemes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OperationInfo class contains authentication information of an +operation element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

schemes (list of AuthenticationInfo) – List of authentication schemes used by an operation element. The +authentication scheme specified on the service element +corresponding to this operation element is ignored.

+
+
+
+ +
+
+class com.vmware.vapi.metadata.authentication_client.Package(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Package class provides methods to retrieve authentication +information of a package element.

+

A package element is said to contain authentication information if there is +a default authentication assigned to all service elements contained in the +package element or if one of the service element contained in this package +element has authentication information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.package'
+

Resource type for package.

+
+ +
+
+get(package_id)
+

Retrieves authentication information about the package element +corresponding to package_id.

+
+
Parameters
+

package_id (str) – Identifier of the package element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.package.

+
+
Return type
+

PackageInfo

+
+
Returns
+

The PackageInfo instance that corresponds to +package_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the package element associated with package_id does not have +any authentication information.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the package elements that have +authentication information.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the package elements that have +authentication information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.package.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.authentication_client.PackageInfo(schemes=None, services=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PackageInfo class contains authentication information of a package +element.

+

For an explanation of authentication information contained within package +elements, see Package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • schemes (list of AuthenticationInfo) – List of authentication schemes to be used for all the operation +elements contained in this package element. If a particular service +or operation element has no explicit authentications defined in the +authentication defintion file, these authentication schemes are +used for authenticating the user.

    • +

  • services (dict of str and ServiceInfo) –

    Information about all service elements contained in this package +element that contain authentication information. The key in the +dict is the identifier of the service element and the +value in the dict is the authentication information for +the service element.

    +

    For an explanation of authentication information containment within +service elements, see Service. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.service. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.service.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.authentication_client.Service(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Service class provides methods to retrieve authentication +information of a service element.

+

A service element is said to contain authentication information if there is +a default authentication assigned to all operation elements contained in a +service element or if one of the operation elements contained in this +service element has authentication information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.service'
+

Resource type for service.

+
+ +
+
+get(service_id)
+

Retrieves authentication information about the service element +corresponding to service_id.

+
+
Parameters
+

service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

+
+
Return type
+

ServiceInfo

+
+
Returns
+

The ServiceInfo instance that corresponds to +service_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not have +any authentication information.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the service elements that have +authentication information.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the service elements that have +authentication information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.service.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.authentication_client.ServiceInfo(schemes=None, operations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServiceInfo class contains authentication information of a service +element.

+

For an explanation of authentication information contained within service +elements, see Service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • schemes (list of AuthenticationInfo) – List of authentication schemes to be used for all the operation +elements contained in this service element. The authentication +scheme specified on the package element corresponding to this +service element is ignored.

    • +

  • operations (dict of str and OperationInfo) –

    Information about all operation elements contained in this service +element that contain authentication information. The key in the +dict is the identifier of the operation element and the +value in the dict is the authentication information for +the operation element.

    +

    For an explanation of containment of authentication information +within operation elements, see +com.vmware.vapi.metadata.authentication.service_client.Operation. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.operation. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.operation.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.authentication_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vapi.metadata.cli_client module

+

The com.vmware.vapi.metadata.cli_client module provides classes that expose +all the information required to display namespace or command help, execute a +command and display it’s result.

+
+
+class com.vmware.vapi.metadata.cli_client.Command(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Command class provides methods to get information about command +line interface (CLI) commands.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FormatterType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Command.FormatterType class defines supported CLI output formatter +types. See Command.Info.formatter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the FormatterType instance.

+
+
+
+
+CSV = FormatterType(string='CSV')
+

Displays command output in CSV format.

+
+ +
+
+HTML = FormatterType(string='HTML')
+

Displays command output in HTML format.

+
+ +
+
+JSON = FormatterType(string='JSON')
+

Displays command output in JSON format.

+
+ +
+
+SIMPLE = FormatterType(string='SIMPLE')
+

Displays command output as it is.

+
+ +
+
+TABLE = FormatterType(string='TABLE')
+

Displays command output in table format.

+
+ +
+
+XML = FormatterType(string='XML')
+

Displays command output in XML format.

+
+ +
+ +
+
+class GenericType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Command.GenericType class defines generic types supported by +Command class. See Command.OptionInfo.generic.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the GenericType instance.

+
+
+
+
+LIST = GenericType(string='LIST')
+

Input parameter is a list.

+
+ +
+
+LIST_OPTIONAL = GenericType(string='LIST_OPTIONAL')
+

Input parameter is a list of optionals. This class attribute was added in +vSphere API 6.5.

+
+ +
+
+NONE = GenericType(string='NONE')
+

Default case.

+
+ +
+
+OPTIONAL = GenericType(string='OPTIONAL')
+

Input parameter is an optional.

+
+ +
+
+OPTIONAL_LIST = GenericType(string='OPTIONAL_LIST')
+

Input parameter is an optional of type list. This class attribute was added +in vSphere API 6.5.

+
+ +
+ +
+
+class Identity(path=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Command.Identity class uniquely identifies a command in the CLI +commands tree.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) – The dot-separated path of the namespace containing the command in +the CLI command tree.

    • +

  • name (str) – Name of the command.

    • +
+
+
+
+ +
+
+class Info(identity=None, description=None, service_id=None, operation_id=None, options=None, formatter=None, output_field_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Command.Info class contains information about a command. It +includes the identity of the command, a description, information about the +class and method that implement the command, and CLI-specific information +for the command.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • identity (Command.Identity) – Basic command identity.

    • +

  • description (str) – The text description displayed to the user in help output.

    • +

  • service_id (str) – The service identifier that contains the operations for this CLI +command. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation_id (str) – The operation identifier corresponding to this CLI command. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • options (list of Command.OptionInfo) – The input for this command.

    • +

  • formatter (Command.FormatterType or None) – The formatter to use when displaying the output of this command. +If not present, client can choose a default output formatter.

    • +

  • output_field_list (list of Command.OutputInfo) – List of output structure name and output field info.

    • +
+
+
+
+ +
+
+class OptionInfo(long_option=None, short_option=None, field_name=None, description=None, type=None, generic=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Command.OptionInfo class describes information about a specific +input option of a command.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • long_option (str) – The long option name of the parameter as used by the user.

    • +

  • short_option (str or None) – The single character value option name. +If not present, there’s no single character option for the +parameter.

    • +

  • field_name (str) – The fully qualified name of the option referred to by the operation +element in Command.Info.operation_id.

    • +

  • description (str) – The description of the option to be displayed to the user when they +request usage information for a CLI command.

    • +

  • type (str) – The type of option. This is used to display information about what +kind of data is expected (string, number, boolean, etc.) for the +option when they request usage information for a CLI command. For +class this stores the fully qualified class id.

    • +

  • generic (Command.GenericType) – This is used to tell the user whether the option is required or +optional, or whether they can specify the option multiple times.

    • +
+
+
+
+ +
+
+class OutputFieldInfo(field_name=None, display_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Command.OutputFieldInfo class describes the name used by the CLI to +display a single attribute of a class element in the interface definition +language.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • field_name (str) – Name of the attribute.

    • +

  • display_name (str) – Name used by the CLI to display the attribute.

    • +
+
+
+
+ +
+
+class OutputInfo(structure_id=None, output_fields=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Command.OutputInfo class describes the names used by the CLI to +display the attributes of a class element in the interface definition +language as well as the order in which the attributes will be displayed.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • structure_id (str) – Name of the class. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure.

    • +

  • output_fields (list of Command.OutputFieldInfo) – The order in which the attributes of the class will be displayed by +the CLI as well as the names used to display the attributes.

    • +
+
+
+
+ +
+
+fingerprint()
+

Returns the aggregate fingerprint of all the command metadata from all +the metadata sources.

+

The fingerprint provides clients an efficient way to check if the +metadata for commands has been modified on the server.

+
+
Return type
+

str

+
+
Returns
+

Fingerprint of all the command metadata present on the server.

+
+
+
+ +
+
+get(identity)
+

Retrieves information about a command including information about how +to execute that command.

+
+
Parameters
+

identity (Command.Identity) – Identifier of the command for which to retreive information.

+
+
Return type
+

Command.Info

+
+
Returns
+

Information about the command including information about how to +execute that command.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a command corresponding to identity doesn’t exist.

+
+
+
+ +
+
+list(path=None)
+

Returns the identifiers of all commands, or commands in a specific +namespace.

+
+
Parameters
+

path (str or None) – The dot-separated path of the namespace for which command +identifiers should be returned. +If None identifiers of all commands registered with the +infrastructure will be returned.

+
+
Return type
+

list of Command.Identity

+
+
Returns
+

Identifiers of the requested commands.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a namespace corresponding to path doesn’t exist.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.cli_client.Namespace(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Namespace class provides methods to get information about command +line interface (CLI) namespaces.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Identity(path=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Namespace.Identity class uniquely identifies a namespace in the CLI +namespace tree.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) – The dot-separated path of the namespace containing the namespace in +the CLI node tree. For top-level namespace this will be empty.

    • +

  • name (str) – The name displayed to the user for this namespace.

    • +
+
+
+
+ +
+
+class Info(identity=None, description=None, children=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Namespace.Info class contains information about a namespace. It +includes the identity of the namespace, a description, information children +namespaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • identity (Namespace.Identity) – Basic namespace identity.

    • +

  • description (str) – The text description displayed to the user in help output.

    • +

  • children (list of Namespace.Identity) – The children of this namespace in the tree of CLI namespaces.

    • +
+
+
+
+ +
+
+fingerprint()
+

Returns the aggregate fingerprint of all the namespace metadata from +all the metadata sources.

+

The fingerprint provides clients an efficient way to check if the +metadata for namespaces has been modified on the server.

+
+
Return type
+

str

+
+
Returns
+

Fingerprint of all the namespace metadata present on the server.

+
+
+
+ +
+
+get(identity)
+

Retreives information about a namespace including information about +children of that namespace.

+
+
Parameters
+

identity (Namespace.Identity) – Identifier of the namespace for which to retreive information.

+
+
Return type
+

Namespace.Info

+
+
Returns
+

Information about the namespace including information about child +of that namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a namespace corresponding to identity doesn’t exist.

+
+
+
+ +
+
+list()
+

Returns the identifiers of all namespaces registered with the +infrastructure.

+
+
Return type
+

list of Namespace.Identity

+
+
Returns
+

Identifiers of all the namespaces.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.cli_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vapi.metadata.metamodel_client module

+

The com.vmware.vapi.metadata.metamodel_client module provides classes that +expose all the information present in the interface definition language (IDL) +specification.

+

Metamodel metadata is organized into an hierarchy of elements. The main +elements are:

+
    +

  • Enumeration: An enumeration element that has a list of enumeration value +elements.

    • +

  • Constant: A constant element has a name and a value.

    • +

  • Structure: A structure element can have field elements, constant elements and +enumeration elements.

    • +

  • Operation: An operation has a list of parameter elements, result element and +error elements.

    • +

  • Service: A service is a collection of operation elements, structure elements, +enumerated elements and constant elements.

    • +

  • Package: A package is a collection of service elements, structure elements +and enumeration elements.

    • +

  • Component: A component is a collection of package elements.

    • +
+

The com.vmware.vapi.metadata.metamodel_client module has classes that +enables two styles of client applications:

+
    +

  • A client can retrieve the exact pieces of information it requires using the +various granularities the API supports (that is Component, +Package, Service, Structure, Enumeration +and com.vmware.vapi.metadata.metamodel.service_client.Operation). In +this case, it doesn’t cache any information locally and always invokes methods +to get the metamodel information it requires.

    • +

  • A client can retrieve all the metamodel information in fewer method +invocations using the Component class and cache the output locally. It +can then poll on the fingerprint information exposed by the Component +class to monitor changes in API definition.

    • +
+
+
+class com.vmware.vapi.metadata.metamodel_client.Component(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Component class providers methods to retrieve metamodel information +of a component element.

+

A component defines a set of functionality that is deployed together and +versioned together. For example, all the classes that belong to VMware +Content Library are part of a single component. A component element +describes a component. A component element contains one or more package +elements.

+

The methods for package elements are provided by class Package.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.component'
+

Resource type for component.

+
+ +
+
+fingerprint(component_id)
+

Retrieves the fingerprint computed from the metamodel metadata of the +component element corresponding to component_id.

+

The fingerprint provides clients an efficient way to check if the +metadata for a particular component element has been modified on the +server. The client can do this by comparing the result of this +operation with the fingerprint returned in the result of +Component.get().

+
+
Parameters
+

component_id (str) – Identifier of the component element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.component.

+
+
Return type
+

str

+
+
Returns
+

The fingerprint computed from the metamodel metadata of the +component element.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the component element associated with component_id is not +registered with the infrastructure.

+
+
+
+ +
+
+get(component_id)
+

Retrieves metamodel information about the component element +corresponding to component_id.

+

The ComponentData contains the metamodel information about the +component and it’s fingerprint. It contains information about all the +package elements that are contained in this component element.

+
+
Parameters
+

component_id (str) – Identifier of the component element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.component.

+
+
Return type
+

ComponentData

+
+
Returns
+

The ComponentData instance that corresponds to +component_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the component element associated with component_id is not +registered with the infrastructure.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the component elements that are registered +with the infrastructure.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the component elements that are +registered with the infrastructure. +The return value will contain identifiers for the resource type: +com.vmware.vapi.component.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ComponentData(info=None, fingerprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentData class contains the metamodel metadata information of +a component element along with its fingerprint.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (ComponentInfo) –

    Metamodel information of the component element. This includes +information about all the package elements contained in this +component element.

    +

    The metamodel information about a component could be quite large if +there are a lot of package elements contained in this component.

    +

    • +

  • fingerprint (str) –

    Fingerprint of the metamodel metadata of the component component.

    +

    Metamodel information could change when there is an infrastructure +update and new functionality is added to an existing component.

    +

    Since the data present in ComponentData.info could be quite +large, fingerprint provides a convenient way to check if the +data for a particular component is updated.

    +

    You should store the fingerprint associated with a component. After +an update, by invoking the Component.fingerprint() method, +you can retrieve the new fingerprint for the component. If the new +fingerprint and the previously stored fingerprint do not match, +clients can use the Component.get() to retrieve the new +metamodel information for the component.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ComponentInfo(name=None, packages=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentInfo class contains metamodel metadata information about a +component element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Dot separated name of the component element. The segments in the +name reflect the organization of the APIs. The format of each +segment is lower case with underscores. Each underscore represents +a word boundary. If there are acronyms in the word, the +capitalization is preserved. This format makes it easy to translate +the segment into a different naming convention.

    • +

  • packages (dict of str and PackageInfo) – Metamodel metadata information of all the package elements +contained in the component element. The key in the dict is +the identifier of the package element and the value in the +dict is the metamodel information of the package element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.package. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.package.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata for the component element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) – English language documentation for a component. It can contain HTML +markup and documentation tags (similar to Javadoc tags). The first +sentence of the package documentation is a complete sentence that +identifies the component by name and summarizes the purpose of the +component.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ConstantInfo(type=None, value=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConstantInfo class contains metamodel information of the constant +elements.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Type) – Type of the constant element.

    • +

  • value (ConstantValue) – Value of the constant element.

    • +

  • documentation (str) – English language documentation for the constant element. It can +contain HTML markup and documentation tags (similar to Javadoc +tags).

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ConstantValue(category=None, primitive_value=None, list_value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConstantValue class contains the metamodel information of the +constant element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Category(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ConstantValue.Category class defines class attributes for the valid +kinds of values.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Category instance.

+
+
+
+
+LIST = Category(string='LIST')
+

Indicates the type of constant value is a list.

+
+ +
+
+PRIMITIVE = Category(string='PRIMITIVE')
+

Indicates the type of constant value is primitive.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ElementMap(elements=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ElementMap class contains the metadata elements.

+

One of the sources for metadata is the annotations present in the interface +definition language. When an annotation is represented in the +ElementMap, ElementMap describes the data specified in the +arguments for the annotation.

+

For example, in \\@UnionCase(tag="tag", value="SELECT"), ElementMap +describes the keyword arguments tag and value.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

elements (dict of str and ElementValue) – Metamodel information of the metadata elements. The key parameter +of the dict is the identifier for the element and the +value corresponds to the element value.

+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ElementValue(type=None, long_value=None, string_value=None, list_value=None, structure_id=None, structure_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ElementValue class describes the value of the metadata element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (ElementValue.Type) – Type of the value.

    • +

  • long_value (long) – Long value of the metadata element. +This attribute is optional and it is only relevant when the value +of type is ElementValue.Type.LONG.

    • +

  • string_value (str) – String value of the metadata element. +This attribute is optional and it is only relevant when the value +of type is ElementValue.Type.STRING.

    • +

  • list_value (list of str) – List of strings value of the metadata element. +This attribute is optional and it is only relevant when the value +of type is ElementValue.Type.STRING_LIST.

    • +

  • structure_id (str) – Identifier of the structure element. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure. +This attribute is optional and it is only relevant when the value +of type is ElementValue.Type.STRUCTURE_REFERENCE.

    • +

  • structure_ids (list of str) – List of identifiers of the structure elements. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.vapi.structure. +This attribute is optional and it is only relevant when the value +of type is ElementValue.Type.STRUCTURE_REFERENCE_LIST.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ElementValue.Type class defines the valid types for values in +metadata elements.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+LONG = Type(string='LONG')
+

Indicates the type of the value is a long (64 bit signed integer).

+
+ +
+
+STRING = Type(string='STRING')
+

Indicates the type of the value is a string (a variable length sequence of +characters). The encoding is UTF-8.

+
+ +
+
+STRING_LIST = Type(string='STRING_LIST')
+

Indicates the type of the value is a list of strings.

+
+ +
+
+STRUCTURE_REFERENCE = Type(string='STRUCTURE_REFERENCE')
+

Indicates the type of the value is an identifier for a structure element.

+
+ +
+
+STRUCTURE_REFERENCE_LIST = Type(string='STRUCTURE_REFERENCE_LIST')
+

Indicates the type of the value is a list of identifiers for a structure +element.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.Enumeration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Enumeration class provides methods to retrieve metamodel +information about an enumeration element in the interface definition +language.

+

The Enumeration has a list of enumeration value elements.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.enumeration'
+

Resource type for enumeration.

+
+ +
+
+get(enumeration_id)
+

Retrieves information about the enumeration element corresponding to +enumeration_id.

+

The EnumerationInfo contains the metamodel information about +the enumeration value element contained in the enumeration element.

+
+
Parameters
+

enumeration_id (str) – Identifier of the enumeration element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.enumeration.

+
+
Return type
+

EnumerationInfo

+
+
Returns
+

The EnumerationInfo instance that corresponds to +enumeration_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the enumeration element associated with enumeration_id is +not contained in any of the package elements, service elements and +structure elements.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the enumeration elements that are contained +in all the package elements, service elements and structure elements.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the enumeration elements. +The return value will contain identifiers for the resource type: +com.vmware.vapi.enumeration.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.EnumerationInfo(name=None, values=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EnumerationInfo class contains the metamodel information of an +enumeration element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Dot separated name of the enumeration element. The segments in the +name reflect the organization of the APIs. The format of each +segment is lower case with underscores. Each underscore represents +a word boundary. If there are acronyms in the word, the +capitalization is preserved. This format makes it easy to translate +the segment into a different naming convention.

    • +

  • values (list of EnumerationValueInfo) – Metamodel information of all the enumeration value elements +contained in this enumeration element. The order of the enumeration +value elements in the list is same as the order in which they are +defined in the interface definition file.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for an enumeration element. The key in +the dict is the name of the metadata element and the value +is the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) –

    English language documentation for an enumeration element. It can +contain HTML markup and Javadoc tags. The first sentence of the +enumeration documentation is a complete sentence that identifies +the enumeration by name and summarizes the purpose of the +enumeration. The documentation describes the context in which the +enumeration is used.

    +

    The documentation also contains references to the context in which +the enumeration is used. But if the enumeration is used in many +contexts, the references may not be present.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo(value=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EnumerationValueInfo class describes the class attribute in the +class.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • value (str) – Value in the enumerated type. All the characters in the string are +capitalized.

    • +

  • metadata (dict of str and ElementMap) –

    Additional metadata for enumeration value in the enumerated type. +The key in the dict is the name of the metadata element +and the value is the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) – English language documentation for an enumeration value. It can +contain HTML markup and documentation tags (similar to Javadoc +tags). The first statement will be a noun or verb phrase that +describes the purpose of the enumeration value.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ErrorInfo(structure_id=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ErrorInfo class contains the metadata information about the error +elements contained in an operation element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • structure_id (str) – Identifier for the structure element corresponding to the error +that is being reported by the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure.

    • +

  • documentation (str) – The English language documentation for the error element. It can +contain HTML markup and Javadoc tags.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.FieldInfo(name=None, type=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The FieldInfo class contains metamodel information of a field element +contained in a structure element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the field element in a canonical format. The format is +lower case with underscores. Each underscore represents a word +boundary. If there are acronyms in the word, the capitalization is +preserved. This format makes it easy to translate the segment into +a different naming convention.

    • +

  • type (Type) – Type information.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for the field element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) – English language documentation for the field element. It can +contain HTML markup and Javadoc tags.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.GenericInstantiation(generic_type=None, element_type=None, map_key_type=None, map_value_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The GenericInstantiation class describes the type information of a +typed element when the type is an instantiation of one of the generic types +provided by the infrastructure.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class GenericType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The GenericInstantiation.GenericType class provides class attributes +for each of the generic types provided by the infrastructure.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the GenericType instance.

+
+
+
+
+LIST = GenericType(string='LIST')
+

Indicates the generic type is a list.

+
+ +
+
+MAP = GenericType(string='MAP')
+

Indicates the generic type is a map.

+
+ +
+
+OPTIONAL = GenericType(string='OPTIONAL')
+

Indicates the generic type is an optional.

+
+ +
+
+SET = GenericType(string='SET')
+

Indicates the generic type is a set.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The MetadataIdentifier class provides string constants that can be used +as identifiers for the metadata elements.

+

Most of the types in com.vmware.vapi.metadata.metamodel_client +package has a metadata field whose type is Map<String, ElementMap>. +MetadataIdentifier contains the identifiers used in the keys of +the above Map type.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+CANONICAL_NAME = 'CanonicalName'
+

Identifier representing the CanonicalName metadata.

+
+ +
+
+COMPONENT = 'Component'
+

Identifier representing the Component metadata.

+
+ +
+
+CREATE = 'Create'
+

Identifier representing the Create metadata.

+
+ +
+
+CRUD = 'Crud'
+

Identifier representing the Crud metadata.

+
+ +
+
+HAS_FIELDS_OF = 'HasFieldsOf'
+

Identifier representing the HasFieldsOf metadata.

+
+ +
+
+INCLUDABLE = 'Includable'
+

Identifier representing the Includable metadata.

+
+ +
+
+INCLUDE = 'Include'
+

Identifier representing the Include metadata.

+
+ +
+
+IS_ONE_OF = 'IsOneOf'
+

Identifier representing the IsOneOf metadata.

+
+ +
+
+MODEL = 'Model'
+

Identifier representing the Model metadata.

+
+ +
+
+READ = 'Read'
+

Identifier representing the Read metadata.

+
+ +
+
+RESOURCE = 'Resource'
+

Identifier representing the Resource metadata.

+
+ +
+
+UNION_CASE = 'UnionCase'
+

Identifier representing the UnionCase metadata.

+
+ +
+
+UNION_TAG = 'UnionTag'
+

Identifier representing the UnionTag metadata.

+
+ +
+
+UPDATE = 'Update'
+

Identifier representing the Update metadata.

+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.OperationInfo(name=None, params=None, output=None, errors=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OperationInfo class contains metamodel information of an operation +element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the operation element in a canonical format. The format is +lower case with underscores. Each underscore represents a word +boundary. If there are acronyms in the word, the capitalization is +preserved. This format makes it easy to translate the segment into +a different naming convention.

    • +

  • params (list of FieldInfo) – Metamodel information for the parameter elements. The order of the +parameters elements in the list is same as the order of the +parameters declared in the interface definition file.

    • +

  • output (OperationResultInfo) – Metamodel type for the output element.

    • +

  • errors (list of ErrorInfo) – List of error elements that might be reported by the operation +element. If the operation reports the same error for more than one +reason, the list contains the error element associated with the +error more than once with different documentation elements.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for the operation element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +key in the dict.

    +

    • +

  • documentation (str) – English language documentation for the operation element. It can +contain HTML markup and Javadoc tags.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.OperationResultInfo(type=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OperationResultInfo class contains the metamodel information of an +operation result element.

+

An operation accepts a list of parameters and returns a result or an error. +The OperationResultInfo describes the result element of an operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Type) – Type information of the operation result element.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for the service element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) – English language documentation for the operation result element. It +can contain HTML markup and Javadoc tags.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.Package(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Package class provides methods to retrieve metamodel information +about a package element in the interface definition language.

+

A package is a logical grouping of services, structures and enumerations. A +package element describes the package. It contains the service elements, +structure elements and enumeration elements that are grouped together.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.package'
+

Resource type for package.

+
+ +
+
+get(package_id)
+

Retrieves information about the package element corresponding to +package_id.

+
+
Parameters
+

package_id (str) – Identifier of the package element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.package.

+
+
Return type
+

PackageInfo

+
+
Returns
+

The PackageInfo instance that corresponds to +package_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the package element associated with package_id does not +exist.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the packages elements that are contained in +all the registered component elements.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the package elements that are contained +in all the registered component elements. +The return value will contain identifiers for the resource type: +com.vmware.vapi.package.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.PackageInfo(name=None, structures=None, enumerations=None, services=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PackageInfo class contains the metamodel information of all the +service elements, structure elements and enumeration elements contained in +the package element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Dot separated name of the package element. The segments in the name +reflect the organization of the APIs. The format of each segment is +lower case with underscores. Each underscore represents a word +boundary. If there are acronyms in the word, the capitalization is +preserved. This format makes it easy to translate the segment into +a different naming convention.

    • +

  • structures (dict of str and StructureInfo) –

    Metamodel information of all the structure elements contained in +the package element. The key in the dict is the identifier +of the structure element and the value in the dict is the +metamodel information for the structure element.

    +

    This does not include the structure elements contained in the +service elements that are contained in this package element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.structure. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.structure.

    +

    • +

  • enumerations (dict of str and EnumerationInfo) –

    Metamodel information of all the enumeration elements contained in +the package element. The key in the dict is the identifier +of the enumeration element and the value in the dict is +the metamodel information for the enumeration element.

    +

    This does not include the enumeration elements that are contained +in the service elements of this package element or structure +elements of this package element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.enumeration. When methods return a value +of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.enumeration.

    +

    • +

  • services (dict of str and ServiceInfo) – Metamodel information of all the service elements contained in the +package element. The key in the dict is the identifier of +the service element and the value in the dict is the +metamodel information for the service element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.service. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.service.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for the package element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) –

    English language documentation for a package. It can contain HTML +markup and Javadoc tags. The first sentence of the package +documentation is a complete sentence that identifies the package by +name and summarizes the purpose of the package.

    +

    The primary purpose of a package documentation is to provide +high-level context that will provide a framework in which the users +can put the detail about the package contents.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.PrimitiveValue(type=None, boolean_value=None, double_value=None, long_value=None, string_value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrimitiveValue class contains value of the constant element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (PrimitiveValue.Type) – Type of the constant value.

    • +

  • boolean_value (bool) – Boolean value of the constant. +This attribute is optional and it is only relevant when the value +of type is PrimitiveValue.Type.BOOLEAN.

    • +

  • double_value (float) – Double value of the constant. +This attribute is optional and it is only relevant when the value +of type is PrimitiveValue.Type.DOUBLE.

    • +

  • long_value (long) – Long value of the constant. +This attribute is optional and it is only relevant when the value +of type is PrimitiveValue.Type.LONG.

    • +

  • string_value (str) – String value of the constant. +This attribute is optional and it is only relevant when the value +of type is PrimitiveValue.Type.STRING.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The PrimitiveValue.Type class defines the valid types for values in +constant elements.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+BOOLEAN = Type(string='BOOLEAN')
+

Indicates the value is a boolean (true or false).

+
+ +
+
+DOUBLE = Type(string='DOUBLE')
+

Indicates the value is a double (64 bit floating number).

+
+ +
+
+LONG = Type(string='LONG')
+

Indicates the value is a long (64 bit signed integer).

+
+ +
+
+STRING = Type(string='STRING')
+

Indicates the value is a string (a variable length sequence of characters). +The encoding is UTF8.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.Resource(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Resource class provides methods to retrieve information about +resource types.

+

A service is a logical grouping of operations that operate on an entity. +Each entity is identifier by a namespace (or resource type) and an unique +identifier.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.resource'
+

Resource type for resource.

+
+ +
+
+list()
+

Returns the set of resource types present across all the service +elements contained in all the package elements.

+
+
Return type
+

set of str

+
+
Returns
+

Set of resource types +The return value will contain identifiers for the resource type: +com.vmware.vapi.resource.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.Service(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Service class provides methods to retrieve metamodel information +about a service element in the interface definition language.

+

A service is a logical grouping of operations that operate on some entity. +A service element describes a service. It contains operation elements that +describe the operations grouped in the service. It also contains structure +elements and enumeration elements corresponding to the structures and +enumerations defined in the service.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.service'
+

Resource type for service.

+
+ +
+
+get(service_id)
+

Retrieves information about the service element corresponding to +service_id.

+

The ServiceInfo contains the metamodel information for the +operation elements, structure elements and enumeration elements +contained in the service element.

+
+
Parameters
+

service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

+
+
Return type
+

ServiceInfo

+
+
Returns
+

The ServiceInfo instance that corresponds to +service_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id is not +registered with the infrastructure.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the service elements that are currently +registered with the infrastructure.

+

The list of service elements is an aggregate list of all the service +elements contained in all the package elements.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the service elements that are currently +registered with the infrastructure. +The return value will contain identifiers for the resource type: +com.vmware.vapi.service.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.ServiceInfo(name=None, operations=None, structures=None, enumerations=None, constants=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServiceInfo class contains the metamodel information of all the +operation elements, structure elements and enumeration elements containted +in a service element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Dot separated name of the service element. The segments in the name +reflect the organization of the APIs. The format of each segment is +lower case with underscores. Each underscore represents a word +boundary. If there are acronyms in the word, the capitalization is +preserved. This format makes it easy to translate the segment into +a different naming convention.

    • +

  • operations (dict of str and OperationInfo) – Metamodel information of all the operation elements contained in +the service element. The key in the dict is the identifier +of the operation element and the value in the dict is the +metamodel information for the operation element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.operation. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.operation.

    • +

  • structures (dict of str and StructureInfo) – Metamodel information of all the structure elements contained in +the service element. The key in the dict is the identifier +of the structure element and the value in the dict is the +metamodel information for the structure element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.structure. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.structure.

    • +

  • enumerations (dict of str and EnumerationInfo) – Metamodel information of all the enumeration elements contained in +the service element. The key in the dict is the identifier +of the enumeration element and the value in the dict is +the metamodel information for the enumeration element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.enumeration. When methods return a value +of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.enumeration.

    • +

  • constants (dict of str and ConstantInfo) – Metamodel information of all the constant elements contained in the +service element. The key in the dict is the name of the +constant element and the value in the dict is the +metamodel information for the contant element.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for the service element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) – English language documentation for the service element. It can +contain HTML markup and Javadoc tags. The first sentence of the +service documentation is a complete sentence that identifies the +service by name and summarizes the purpose of the service. The +remaining part of the documentation provides a summary of how to +use the operations defined in the service.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.Structure(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Structure class providers methods to retrieve metamodel information +about a structure element in the interface definition language.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.structure'
+

Resource type for structure.

+
+ +
+
+get(structure_id)
+

Retrieves information about the structure element corresponding to +structure_id.

+

The StructureInfo contains the metamodel information about the +structure element. It contains information about all the field elements +and enumeration elements contained in this structure element.

+
+
Parameters
+

structure_id (str) – Identifier of the structure element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.structure.

+
+
Return type
+

StructureInfo

+
+
Returns
+

The StructureInfo instance that corresponds to +structure_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the structure element associated with structure_id is not +contained in any of the package elements or service elements.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the structure elements that are contained +in all the package elements and service elements.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the structure elements. +The return value will contain identifiers for the resource type: +com.vmware.vapi.structure.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.StructureInfo(name=None, type=None, enumerations=None, constants=None, fields=None, metadata=None, documentation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StructureInfo class contains the metamodel information of all the +field elements, constant elements and enumeration elements contained in the +structure element.

+

In the interface definition language, API designers have the ability to +include all the fields from one structure to another structure. This is +done by using an annotation \\@Include on the structure in which we +want to add the fields. If this annotation is present, the list of fields +in the StructureInfo will also contain the fields that are being +included. The annotation information is also retained in the +StructureInfo.metadata element as well.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Dot separated name of the structure element. The segments in the +name reflect the organization of the APIs. The format of each +segment is lower case with underscores. Each underscore represents +a word boundary. If there are acronyms in the word, the +capitalization is preserved. This format makes it easy to translate +the segment into a different naming convention.

    • +

  • type (StructureInfo.Type) – Type of the structure.

    • +

  • enumerations (dict of str and EnumerationInfo) – Metamodel information of all the enumeration elements contained in +the structure element. The key in the dict is the +identifier of the enumeration element and the value is the +metamodel information of the enumeration element. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.enumeration. When methods return a value +of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.enumeration.

    • +

  • constants (dict of str and ConstantInfo) – Metamodel information of all the constant elements contained in the +structure element. The key in the dict is the name of the +constant element and the value in the dict is the +metamodel information for the constant element.

    • +

  • fields (list of FieldInfo) – Metamodel information of all the field elements. The order of the +field elements in the list matches the order in which the fields +are defined in the service.

    • +

  • metadata (dict of str and ElementMap) –

    Generic metadata elements for the structure element. The key in the +dict is the name of the metadata element and the value is +the data associated with that metadata element.

    +

    The MetadataIdentifier contains possible string values for +keys in the dict.

    +

    • +

  • documentation (str) – English language documentation for a structure element. It can +contain HTML markup and Javadoc tags. The first sentence of the +structure documentation is a complete sentence that identifies the +structure by name and summarizes the purpose of the structure.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The StructureInfo.Type class defines the kind of this structure +element. In the interface definition language, structure element and error +element have similar characteristics. The difference is that only error +elements can be used to describe the exceptions of an operation element.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+ERROR = Type(string='ERROR')
+

If the type is an error element.

+
+ +
+
+STRUCTURE = Type(string='STRUCTURE')
+

If the type is a structure element.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.Type(category=None, builtin_type=None, user_defined_type=None, generic_instantiation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Type class describes the type information of a typed element in the +interface definiton language. The following elements in the metamodel are +typed:

+
    +

  • Field element in a structure element. See StructureInfo.fields

    • +

  • Parameter element in an operation element. See +OperationInfo.params

    • +

  • Result element in an operation element. See OperationInfo.output

    • +
+

The type could be one of the three following categories:

+
    +

  • Built-in types: These are types present in the interface definition +language type system. They are provided by the infrastructure.

    • +

  • User defined named type: API designers can create custom types and use +them for the typed elements. These types have a unique identifier.

    • +

  • Generic type instantiation: The language infrastructure also provides +generic types such as list, map, set and so on. An instantiation of one of +these generic types could also be used for the typed elements.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • category (Type.Category) – Category of this type.

    • +

  • builtin_type (Type.BuiltinType) – Category of the built-in type. +This attribute is optional and it is only relevant when the value +of category is Type.Category.BUILTIN.

    • +

  • user_defined_type (UserDefinedType) – Identifier and type of the user defined type. +This attribute is optional and it is only relevant when the value +of category is Type.Category.USER_DEFINED.

    • +

  • generic_instantiation (GenericInstantiation) – Instantiation of one of the generic types available in the +interface definition language. +This attribute is optional and it is only relevant when the value +of category is Type.Category.GENERIC.

    • +
+
+
+
+
+class BuiltinType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Type.BuiltinType class provides class attribute for each of the +built-in types present in the interface definition language type system.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BuiltinType instance.

+
+
+
+
+ANY_ERROR = BuiltinType(string='ANY_ERROR')
+

The built-in type is an arbitrary exception type. This is used if the value +of a typed element can be one of any user defined named type which is an +exception.

+
+ +
+
+BINARY = BuiltinType(string='BINARY')
+

The built-in type is a binary. The value is a variable-length sequence of +zero or more bytes.

+
+ +
+
+BOOLEAN = BuiltinType(string='BOOLEAN')
+

The built-in type is a boolean. The value is true or false.

+
+ +
+
+DATE_TIME = BuiltinType(string='DATE_TIME')
+

The built-in type is a datetime. The value should be in the UTC timezone +and the precision is milliseconds.

+
+ +
+
+DOUBLE = BuiltinType(string='DOUBLE')
+

The built-in type is a double. The value is a 64 bit floating point number.

+
+ +
+
+DYNAMIC_STRUCTURE = BuiltinType(string='DYNAMIC_STRUCTURE')
+

The built-in type is a dynamic structure. This is used if the value of a +typed element can be one of any user defined named type.

+
+ +
+
+ID = BuiltinType(string='ID')
+

The built-in type is an ID. The value represents an identifier for a +resource.

+
+ +
+
+LONG = BuiltinType(string='LONG')
+

The built-in type is a long. The value is a 64 bit signed integer.

+
+ +
+
+OPAQUE = BuiltinType(string='OPAQUE')
+

The built-in type is an opaque. This is used if the value of a typed +element could be of any type and the actual type will be known only during +the execution of the API. This is mostly used in infrastructure classes.

+
+ +
+
+SECRET = BuiltinType(string='SECRET')
+

The built-in type is a secret. The value is a variable-length sequence of +zero or more unicode characters. The value contains sensitive data that +should not be printed or displayed anywhere.

+
+ +
+
+STRING = BuiltinType(string='STRING')
+

The built-in type is a string. The value is a variable-length sequence of +zero or more unicode characters.

+
+ +
+
+URI = BuiltinType(string='URI')
+

The built-in type is an URI. The value follows the IRI specification in RFC +3987.

+
+ +
+
+VOID = BuiltinType(string='VOID')
+

The built-in type is a void. The value is None.

+
+ +
+ +
+
+class Category(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Type.Category class provides class attribute for each category of +the type.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Category instance.

+
+
+
+
+BUILTIN = Category(string='BUILTIN')
+

The type is one of the built-in types specified in +Type.BuiltinType

+
+ +
+
+GENERIC = Category(string='GENERIC')
+

The type is an instantiation of one of the generic types.

+
+ +
+
+USER_DEFINED = Category(string='USER_DEFINED')
+

The type is one of the user defined named types.

+
+ +
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel_client.UserDefinedType(resource_type=None, resource_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UserDefinedType class contains the metamodel type information of a +typed element whose type is a user defined named type.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • resource_type (str) – Category of the user defined named type. The named type could be a +structure element or an enumeration element. +When clients pass a value of this class as a parameter, the +attribute must be one of com.vmware.vapi.structure or +com.vmware.vapi.enumeration. When methods return a value of +this class as a return value, the attribute will be one of +com.vmware.vapi.structure or com.vmware.vapi.enumeration.

    • +

  • resource_id (str) – Identifier of the user defined named type. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for one of these resource types: +com.vmware.vapi.structure or com.vmware.vapi.enumeration. +When methods return a value of this class as a return value, the +attribute will be an identifier for one of these resource types: +com.vmware.vapi.structure or com.vmware.vapi.enumeration.

    • +
+
+
+
+ +
+
+

com.vmware.vapi.metadata.privilege_client module

+

The com.vmware.vapi.metadata.privilege_client module provides classes that +expose privilege information for operation elements across all the service +elements.

+

An entity has a unique identifier and a resource type. An entity can either be +present in one of the parameter elements or if a parameter is a structure +element, it could also be present in one of the field elements.

+

Privileges can be assigned to either operation elements or entities used in the +operation element. A list of privileges can also be applied on a package +element. This list of privileges would be used as a default for all the +operation elements and the entities that do not have any defined privileges.

+
+
+class com.vmware.vapi.metadata.privilege_client.Component(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Component class provides methods to retrieve privilege information +of a component element.

+

A component element is said to contain privilege information if any one of +package elements in it contains privilege information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.component'
+

Resource type for vAPI component.

+
+ +
+
+fingerprint(component_id)
+

Retrieves the fingerprint computed from the privilege metadata of the +component element corresponding to component_id.

+

The fingerprint provides clients an efficient way to check if the +metadata for a particular component has been modified on the server. +The client can do this by comparing the result of this operation with +the fingerprint returned in the result of Component.get().

+
+
Parameters
+

component_id (str) – Identifier of the component element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.component.

+
+
Return type
+

str

+
+
Returns
+

The fingerprint computed from the privilege metadata of the +component.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the component element associated with component_id does not +have any privilege information.

+
+
+
+ +
+
+get(component_id)
+

Retrieves privilege information about the component element +corresponding to component_id.

+

The ComponentData contains the privilege information about the +component element and its fingerprint. It contains information about +all the package elements that belong to this component element.

+
+
Parameters
+

component_id (str) – Identifier of the component element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.component.

+
+
Return type
+

ComponentData

+
+
Returns
+

The ComponentData instance that corresponds to +component_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the component element associated with component_id does not +have any privilege information.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the component elements that have privilege +information.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the component elements that have +privilege information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.component.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.privilege_client.ComponentData(info=None, fingerprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentData class contains the privilege information of the +component along with its fingerprint.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (ComponentInfo) – Privilege information of the component. This includes information +about all the modules in the component.

    • +

  • fingerprint (str) –

    Fingerprint of the metadata of the component.

    +

    Privilege information could change when there is an infrastructure +update. Since the data present in ComponentData.info could +be quite large, fingerprint provides a convenient way to check +if the data for a particular component is updated.

    +

    You should store the fingerprint associated with a component. After +an update, by invoking the Component.fingerprint() method, +you can retrieve the new fingerprint for the component. If the new +fingerprint and the previously stored fingerprint do not match, +clients can then use the Component.get() to retrieve the new +privilege information for the component.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.privilege_client.ComponentInfo(packages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ComponentInfo class contains the privilege information of a +component element.

+

For an explanation of privilege information contained within component +elements, see Component.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

packages (dict of str and PackageInfo) –

Privilege information of all the package elements. The key in the +dict is the identifier of the package element and the +value in the dict is the privilege information for the +package element.

+

For an explanation of privilege information containment within +package elements, see Package. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.package. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.package.

+

+
+
+
+ +
+
+class com.vmware.vapi.metadata.privilege_client.OperationInfo(privileges=None, privilege_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OperationInfo class contains privilege information of an operation +element.

+

For an explanation of containment within operation elements, see +com.vmware.vapi.metadata.privilege.service_client.Operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • privileges (list of str) – List of all privileges assigned to the operation element.

    • +

  • privilege_info (list of PrivilegeInfo) –

    Privilege information of all the parameter elements of the +operation element.

    +

    For an explanation of containment of privilege information within +parameter elements, see PrivilegeInfo.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.privilege_client.Package(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Package class provides methods to retrieve privilege information of +a package element.

+

A package element is said to contain privilege information if there is a +default privilege assigned to all service elements contained in the package +element or if one of the operation elements contained in one of the service +elements in this package element has privilege information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.package'
+

Resource type for package.

+
+ +
+
+get(package_id)
+

Retrieves privilege information about the package element corresponding +to package_id.

+
+
Parameters
+

package_id (str) – Identifier of the package element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.package.

+
+
Return type
+

PackageInfo

+
+
Returns
+

The PackageInfo instance that corresponds to +package_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the package element associated with package_id does not have +any privilege information.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the package elements that have privilege +information.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the package elements that have +privilege information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.package.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.privilege_client.PackageInfo(privileges=None, services=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PackageInfo class contains the privilege information of a package +element.

+

For an explanation of privilege information contained within package +elements, see Package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • privileges (list of str) – List of default privileges to be used for all the operations +present in this package. If a particular operation element has no +explicit privileges defined in the privilege definition file, these +privileges are used for enforcing authorization.

    • +

  • services (dict of str and ServiceInfo) –

    Information about all service elements contained in this package +element that contain privilege information. The key in the +dict is the identifier of the service element and the +value in the dict is the privilege information for the +service element.

    +

    For an explanation of privilege information containment within +service elements, see Service. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.service. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.service.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.privilege_client.PrivilegeInfo(property_path=None, privileges=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrivilegeInfo class contains the privilege information for a +parameter element in an operation element.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • property_path (str) –

    The propertyPath points to an entity that is used in the +operation element. An entity can either be present in one of the +parameter elements or if a parameter is a structure element, it +could also be present in one of the field elements.

    +

    If the privilege is assigned to an entity used in the parameter, +propertyPath will just contain the name of the parameter field. +If the privilege is assigned to an entity in one of the field +elements of a parameter element that is a structure element, then +propertyPath will contain a path to the field element starting +from the parameter name.

    +

    • +

  • privileges (list of str) – List of privileges assigned to the entity that is being referred by +PrivilegeInfo.property_path.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.metadata.privilege_client.Service(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Service class provides methods to retrieve privilege information of +a service element.

+

A service element is said to contain privilege information if one of the +operation elements contained in this service element has privilege +information.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.service'
+

Resource type for service.

+
+ +
+
+get(service_id)
+

Retrieves privilege information about the service element corresponding +to service_id.

+
+
Parameters
+

service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

+
+
Return type
+

ServiceInfo

+
+
Returns
+

The ServiceInfo instance that corresponds to +service_id

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not have +any privilege information.

+
+
+
+ +
+
+list()
+

Returns the identifiers for the service elements that have privilege +information.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the service elements that have +privilege information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.service.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.privilege_client.ServiceInfo(operations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServiceInfo class contains privilege information of a service +element.

+

For an explanation of privilege information contained within service +elements, see Service.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

operations (dict of str and OperationInfo) –

Information about all operation elements contained in this service +element that contain privilege information. The key in the +dict is the identifier of the operation element and the +value in the dict is the privilege information for the +operation element.

+

For an explanation of containment of privilege information within +operation elements, see +com.vmware.vapi.metadata.privilege.service_client.Operation. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vapi.operation. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vapi.operation.

+

+
+
+
+ +
+
+class com.vmware.vapi.metadata.privilege_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vapi.metadata.metamodel.html b/vsphere/8.0.2.0/com.vmware.vapi.metadata.metamodel.html new file mode 100644 index 00000000..6b858763 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vapi.metadata.metamodel.html @@ -0,0 +1,306 @@ + + + + + + + com.vmware.vapi.metadata.metamodel package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vapi.metadata.metamodel package

+
+

Submodules

+
+
+

com.vmware.vapi.metadata.metamodel.resource_client module

+

The com.vmware.vapi.metadata.metamodel.resource_client module provides +classes to retrieve metamodel information for resource types.

+
+
+class com.vmware.vapi.metadata.metamodel.resource_client.Model(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Model class provides methods to retrieve information about models.

+

A structure is used as a model if it is used for persisting data about an +entity. Some of the fields in the model structure are also used for +creating indexes for querying.

+

One or more services can operate on the same resource type. One or more +services can provide the model structure for an entity of this resource +type. Using Model class you can retrieve the list of all the structure +elements that are model structures for a given resource type.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+list(resource_id)
+

Returns the set of identifiers for the structure elements that are +models for the resource type corresponding to resource_id.

+

The com.vmware.vapi.metadata.metamodel_client.Structure class +provides methods to retrieve more details about the structure elements +corresponding to the identifiers returned by this method.

+
+
Parameters
+

resource_id (str) – Identifier of the resource type. +The parameter must be an identifier for the resource type: +com.vmware.vapi.resource.

+
+
Return type
+

set of str

+
+
Returns
+

The set of identifiers for the models that are associated with the +resource type in resource_id. +The return value will contain identifiers for the resource type: +com.vmware.vapi.structure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the resource type associated with resource_id does not +exist.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel.resource_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vapi.metadata.metamodel.service_client module

+

The com.vmware.vapi.metadata.metamodel.service_client module provides +classes to retrieve metamodel information about the elements contained in a +service element.

+
+
+class com.vmware.vapi.metadata.metamodel.service_client.Operation(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Operation class provides methods to retrieve metamodel information +of an operation element in the interface definition language.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.operation'
+

Resource type for operation element.

+
+ +
+
+get(service_id, operation_id)
+

Retrieves the metamodel information about an operation element +corresponding to operation_id contained in the service element +corresponding to service_id.

+
+
Parameters
+
    +

  • service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

    • +

  • operation_id (str) – Identifier of the operation element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.operation.

    • +
+
+
Return type
+

com.vmware.vapi.metadata.metamodel_client.OperationInfo

+
+
Returns
+

The +com.vmware.vapi.metadata.metamodel_client.OperationInfo +instance that corresponds to operation_id defined in scope +service_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not +exist in any of the package elements.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the operation element associated with operation_id does not +exist in the service element.

+
+
+
+ +
+
+list(service_id)
+

Returns the identifiers for the operation elements that are defined in +the scope of service_id.

+
+
Parameters
+

service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

+
+
Return type
+

list of str

+
+
Returns
+

The list of identifiers for the operation elements that are defined +in the scope of service_id. +The return value will contain identifiers for the resource type: +com.vmware.vapi.operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not +exist in any of the package elements.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.metamodel.service_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vapi.metadata.privilege.html b/vsphere/8.0.2.0/com.vmware.vapi.metadata.privilege.html new file mode 100644 index 00000000..2c81939e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vapi.metadata.privilege.html @@ -0,0 +1,247 @@ + + + + + + + com.vmware.vapi.metadata.privilege package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vapi.metadata.privilege package

+
+

Submodules

+
+
+

com.vmware.vapi.metadata.privilege.service_client module

+

The com.vmware.vapi.metadata.privilege.service_client module provides +classes to retrieve privilege information for operation elements.

+
+
+class com.vmware.vapi.metadata.privilege.service_client.Operation(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Operation class provides methods to retrieve privilege information +of an operation element.

+

An operation element is said to contain privilege information if there are +any privileges assigned to the operation element or if one of the parameter +elements contained in it has privileges assigned in privilege definition +file.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vapi.operation'
+

Resource type for operation.

+
+ +
+
+get(service_id, operation_id)
+

Retrieves the privilege information about an operation element +corresponding to operation_id contained in the service element +corresponding to service_id.

+
+
Parameters
+
    +

  • service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

    • +

  • operation_id (str) – Identifier of the operation element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.operation.

    • +
+
+
Return type
+

com.vmware.vapi.metadata.privilege_client.OperationInfo

+
+
Returns
+

The +com.vmware.vapi.metadata.privilege_client.OperationInfo +instance that corresponds to operation_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the operation element associated with operation_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the operation element associated with operation_id does not +have any privilege information.

+
+
+
+ +
+
+list(service_id)
+

Returns the identifiers for the operation elements contained in the +service element corresponding to service_id that have privilege +information.

+
+
Parameters
+

service_id (str) – Identifier of the service element. +The parameter must be an identifier for the resource type: +com.vmware.vapi.service.

+
+
Return type
+

list of str

+
+
Returns
+

List of identifiers for the operation elements contained in the +service element that have privilege information. +The return value will contain identifiers for the resource type: +com.vmware.vapi.operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service element associated with service_id does not have +any operation elements that have privilege information.

+
+
+
+ +
+ +
+
+class com.vmware.vapi.metadata.privilege.service_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vapi.std.html b/vsphere/8.0.2.0/com.vmware.vapi.std.html new file mode 100644 index 00000000..b8f2439f --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vapi.std.html @@ -0,0 +1,2063 @@ + + + + + + + com.vmware.vapi.std package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vapi.std package

+
+

Submodules

+
+
+

com.vmware.vapi.std.errors_client module

+

The com.vmware.vapi.std.errors_client module provides the standard +exceptions that can be included in the list of exceptions in the specification +of methods to indicate that the method might report those exceptions.

+

It also provides some classes intended to be used as payload to provide +additional information about those exceptions.

+
+
+exception com.vmware.vapi.std.errors_client.AlreadyExists(messages=None, data=None, error_type='ALREADY_EXISTS')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The AlreadyExists exception indicates that an attempt was made to +create an entity but the entity already exists. Typically the entity has a +name or identifier that is required to be unique in some context, but there +is already an entity with that name or identifier in that context.

+

Examples:

+
    +

  • Trying to create a new tag category when a tag category with the +specified name already exists.

    • +

  • Trying to create a new tag in tag category when a tag with the specified +name already exists the tag category.

    • +

  • Trying to create a LUN with a specific UUID on a node (for replication +purposes) when a LUN with that UUID already exists on the node.

    • +

  • Trying to create a file in a directory or move or copy a file to a +directory when a file with that name already exists in the directory.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.AlreadyInDesiredState(messages=None, data=None, error_type='ALREADY_IN_DESIRED_STATE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The AlreadyInDesiredState exception indicates that an attempt to change +the state of a resource or service had no effect because the resource or +service is already in the desired state.

+

Examples:

+
    +

  • Trying to power on a virtual machine that is already powered on.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std.errors_client.ArgumentLocations(primary=None, secondary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ArgumentLocations class describes which part(s) of the input to the +method caused the exception.

+

Some types of exceptions are caused by the value of one of the inputs to +the method, possibly due to an interaction with other inputs to the method.

+

This class is intended to be used as the payload to identify those inputs +when the method reports exceptions like InvalidArgument or +NotFound. See Error.data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • primary (str) – String describing the location of the input that triggered the +exception.

    • +

  • secondary (list of str) – list (possibly empty) of strings describing the locations +of other inputs that caused the the primary input to trigger the +exception.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.Canceled(messages=None, data=None, error_type='CANCELED')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The Canceled exception indicates that the method canceled itself in +response to an explicit request to do so. Methods being “canceled” for +other reasons (for example the client connection was closed, a time out +occured, or due to excessive resource consumption) should not report this +exception.

+

Examples:

+
    +

  • A user is monitoring the progress of the method in a GUI and sees that it +is likely to take longer than he is willing to wait and clicks the cancel +button.

    • +

  • A user invokes the method using a command-line tool and decides that she +didn’t really want to invoke that method, and presses CTRL-c.

    • +
+

Counterexamples:

+
    +

  • The client’s connection to the server was closed. Reporting an exception +is pointless since the client will not receive the error response because +the connection has been closed.

    • +

  • The request is taking longer than some amount of time. The +TimedOut exception would be reported if the time was specified as +part of the input or is documented in the API contract.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.ConcurrentChange(messages=None, data=None, error_type='CONCURRENT_CHANGE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The ConcurrentChange exception indicates that a data structure, entity, +or resource has been modified since some earlier point in time. Typically +this happens when the client is doing the write portion of a +read-modify-write sequence and indicates that it wants the server to notify +it if the data in the server has changed after it did the read, so that +it can avoid overwriting that change inadvertantly.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.Error(messages=None, data=None, error_type=None)
+

Bases: vmware.vapi.bindings.error.VapiError

+

The Error exception describes theattributes common to all standard +exceptions.

+

This exception serves two purposes:

+
    +

  1. It is the exception that clients in many programming languages can catch +to handle all standard exceptions. Typically those clients will display one +or more of the localizable messages from Error.messages to a human.

    2. +

  2. It is the exception that methods can report when they need to report +some exception, but the exception doesn’t fit into any other standard +exception, and in fact the only reasonable way for a client to react to the +exception is to display the message(s) to a human.

    3. +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Enumeration of all standard errors. Used as discriminator in protocols that +have no standard means for transporting the error type, e.g. REST. This +enumeration was added in vSphere API 6.7.2.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+ALREADY_EXISTS = Type(string='ALREADY_EXISTS')
+

Discriminator for the AlreadyExists type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+ALREADY_IN_DESIRED_STATE = Type(string='ALREADY_IN_DESIRED_STATE')
+

Discriminator for the AlreadyInDesiredState type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+CANCELED = Type(string='CANCELED')
+

Discriminator for the Canceled type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+CONCURRENT_CHANGE = Type(string='CONCURRENT_CHANGE')
+

Discriminator for the ConcurrentChange type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+
+ERROR = Type(string='ERROR')
+

Discriminator for the Error type. This class attribute was added +in vSphere API 6.7.2.

+
+ +
+
+FEATURE_IN_USE = Type(string='FEATURE_IN_USE')
+

Discriminator for the FeatureInUse type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+INTERNAL_SERVER_ERROR = Type(string='INTERNAL_SERVER_ERROR')
+

Discriminator for the InternalServerError type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+INVALID_ARGUMENT = Type(string='INVALID_ARGUMENT')
+

Discriminator for the InvalidArgument type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+
+INVALID_ELEMENT_CONFIGURATION = Type(string='INVALID_ELEMENT_CONFIGURATION')
+

Discriminator for the InvalidElementConfiguration type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+INVALID_ELEMENT_TYPE = Type(string='INVALID_ELEMENT_TYPE')
+

Discriminator for the InvalidElementType type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+INVALID_REQUEST = Type(string='INVALID_REQUEST')
+

Discriminator for the InvalidRequest type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+
+NOT_ALLOWED_IN_CURRENT_STATE = Type(string='NOT_ALLOWED_IN_CURRENT_STATE')
+

Discriminator for the NotAllowedInCurrentState type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+NOT_FOUND = Type(string='NOT_FOUND')
+

Discriminator for the NotFound type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+OPERATION_NOT_FOUND = Type(string='OPERATION_NOT_FOUND')
+

Discriminator for the OperationNotFound type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+
+RESOURCE_BUSY = Type(string='RESOURCE_BUSY')
+

Discriminator for the ResourceBusy type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+RESOURCE_INACCESSIBLE = Type(string='RESOURCE_INACCESSIBLE')
+

Discriminator for the ResourceInaccessible type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+RESOURCE_IN_USE = Type(string='RESOURCE_IN_USE')
+

Discriminator for the ResourceInUse type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+SERVICE_UNAVAILABLE = Type(string='SERVICE_UNAVAILABLE')
+

Discriminator for the ServiceUnavailable type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+TIMED_OUT = Type(string='TIMED_OUT')
+

Discriminator for the TimedOut type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+UNABLE_TO_ALLOCATE_RESOURCE = Type(string='UNABLE_TO_ALLOCATE_RESOURCE')
+

Discriminator for the UnableToAllocateResource type. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+UNAUTHENTICATED = Type(string='UNAUTHENTICATED')
+

Discriminator for the Unauthenticated type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+
+UNAUTHORIZED = Type(string='UNAUTHORIZED')
+

Discriminator for the Unauthorized type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+UNEXPECTED_INPUT = Type(string='UNEXPECTED_INPUT')
+

Discriminator for the UnexpectedInput type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+
+UNSUPPORTED = Type(string='UNSUPPORTED')
+

Discriminator for the Unsupported type. This class attribute was +added in vSphere API 6.7.2.

+
+ +
+
+UNVERIFIED_PEER = Type(string='UNVERIFIED_PEER')
+

Discriminator for the UnverifiedPeer type. This class attribute +was added in vSphere API 6.7.2.

+
+ +
+ +
+ +
+
+exception com.vmware.vapi.std.errors_client.FeatureInUse(messages=None, data=None, error_type='FEATURE_IN_USE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The FeatureInUse exception indicates that an action cannot be completed +because a feature is in use.

+

Examples:

+
    +

  • Trying to disable snapshots on a virtual machine which has a snapshot.

    • +

  • Trying to downgrade a license that has licensed features that are in use.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std.errors_client.FileLocations(primary=None, secondary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The FileLocations class identifies the file(s) that caused the method +to report the exception.

+

Some types of exceptions are caused by a problem with one or more files. +This class is intended to be used as the payload to identify those files +when the method reports exceptions like NotFound. See +Error.data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • primary (str) – String identifying the file that triggered the exception.

    • +

  • secondary (list of str) – list (possibly empty) of strings identifying other files +that caused the primary file to trigger the exception.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.InternalServerError(messages=None, data=None, error_type='INTERNAL_SERVER_ERROR')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The InternalServerError exception indicates that the server encounters +an unexpected condition that prevented it from fulfilling the request.

+

This exception is reported by the API infrastructure, so it could occur in +response to the invocation of any method.

+

Examples:

+
    +

  • The method returns a value whose type doesn’t match the type type the +method says it should return.

    • +

  • The method reports an exception that is not included in the list of +exceptions the method says that it can report.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.InvalidArgument(messages=None, data=None, error_type='INVALID_ARGUMENT')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The InvalidArgument exception indicates that the values received for +one or more parameters are not acceptable.

+

This exception is reported by the API infrastructure, so it could occur in +response to the invocation of any method. It may also be reported as the +result of method-specific validation.

+

Examples:

+
    +

  • A parameter has a value that is not of the expected type.

    • +

  • A parameter has a value that is not in the required range.

    • +

  • A parameter has a value that is not one of the specifically allowed +strings.

    • +

  • One attribute of a class is the tag for a tagged union, and has a +specific value but another attribute of the class that is required to be +specified when the tag has that value is not specified, or another +attribute of the class that is required to be unspecified when the tag has +that value is specified.

    • +
+

Counterexamples:

+
    +

  • Trying to create a new tag in tag category when a tag with the specified +name already exists the tag category. The AlreadyExists exception +would be used instead.

    • +

  • Invoke the method to retrieve information about a virtual machine, +passing an id that does not identify an existing virtual machine. The +NotFound exception would be used instead.

    • +

  • Attempt to put a virtual machine into a folder that can only contain +hosts. The InvalidElementType exception would be used instead.

    • +

  • Attempt to attach a SCSI virtual disk to an IDE port. The +InvalidElementType exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.InvalidElementConfiguration(messages=None, data=None, error_type='INVALID_ELEMENT_CONFIGURATION')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The InvalidElementConfiguration exception indicates that an attempt to +modify the configuration of an element or a group containing the element +failed due to the configuraton of the element.

+

A typical case is when the method is am attempt to change the group +membership of the element fails, in which case a configuration change on +the element may allow the group membership change to succeed.

+

Examples:

+
    +

  • Attempt to move a host with a fault tolerant virtual machine out of a +cluster (i.e. make the host a standalone host).

    • +

  • Attempt to remove a host from a DRS cluster without putting the host into +maintenance mode.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.InvalidElementType(messages=None, data=None, error_type='INVALID_ELEMENT_TYPE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The InvalidElementType exception indicates that the server was unable +to fulfil the request because an element of a specific type cannot be a +member of particular group.

+

This exception could be reported, for example, if an attempt is made to put +an element into the wrong type of container.

+

Examples:

+
    +

  • Attempt to put a virtual machine into a folder that can only contain +hosts.

    • +

  • Attempt to attach a SCSI virtual disk to an IDE port.

    • +
+

Counterexamples:

+
    +

  • A parameter has a value that is not of the expected type. The +InvalidArgument exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.InvalidRequest(messages=None, data=None, error_type='INVALID_REQUEST')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The InvalidRequest exception indicates that the request is malformed in +such a way that the server is unable to process it.

+

Examples:

+
    +

  • The XML in a SOAP request is not well-formed so the server cannot parse +the request.

    • +

  • The XML in a SOAP request is well-formed but does not match the structure +required by the SOAP specification.

    • +

  • A JSON-RPC request is not valid JSON.

    • +

  • The JSON sent in a JSON-RPC request is not a valid JSON-RPC Request +object.

    • +

  • The Request object from a JSON-RPC request does not match the structure +required by the API infrastructure.

    • +
+

Counterexamples:

+
    +

  • The parameter has a value that is not with the required range. The +InvalidArgument exception would be used instead.

    • +

  • The name of the method specified in the request doesn’t not match any +known method. The NotFound exception would be used instead.

    • +
+

Some transport protocols (for example JSON-RPC) include their own mechanism +for reporting these kinds of errors, and the API infrastructure for a +programming language may expose the errors using a language specific +mechanism, so this exception might not be used.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.NotAllowedInCurrentState(messages=None, data=None, error_type='NOT_ALLOWED_IN_CURRENT_STATE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The NotAllowedInCurrentState exception indicates that the requested +method is not allowed with a resource or service in its current state. This +could be because the method is performing a configuration change that is +not allowed in the current state or because method itself is not allowed in +the current state.

+

Examples:

+
    +

  • Trying to add a virtual device that cannot be hot plugged to a running +virtual machine.

    • +

  • Trying to upgrade the virtual hardware version for a suspended virtual +machine.

    • +

  • Trying to power off, reset, or suspend a virtual machine that is not +powered on.

    • +
+

Counterexamples:

+
    +

  • Trying to power off a virtual machine that is in the process of being +powered on. The ResourceBusy exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.NotFound(messages=None, data=None, error_type='NOT_FOUND')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The NotFound exception indicates that a specified element could not be +found.

+

Examples:

+
    +

  • Invoke the method to retrieve information about a virtual machine, +passing an id that does not identify an existing virtual machine.

    • +

  • Invoke the method to modify the configuration of a virtual nic, passing +an id that does not identify an existing virtual nic in the specified +virtual machine.

    • +

  • Invoke the method to remove a vswitch, passing an id that does not +identify an existing vswitch.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.OperationNotFound(messages=None, data=None, error_type='OPERATION_NOT_FOUND')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The OperationNotFound exception indicates that the method specified in +the request could not be found.

+

Every API request specifies a service identifier and an operation +identifier along with the parameters. If the API infrastructure is unable +to find the requested class or method it reports this exception.

+

This exception can be reported by the API infrastructure for any method, +but it is specific to the API infrastructure, and should never be reported +by the implementation of any method.

+

Examples:

+
    +

  • A client provides an invalid service or operation identifier when +invoking the method using a dynamic interface (for example REST).

    • +

  • A client invokes the method from a class, but that class has not been +installed.

    • +
+

Counterexamples:

+
    +

  • A client invokes a task scheduling method, but provides an invalid +service identifier or operation identifier. The NotFound exception +would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.ResourceBusy(messages=None, data=None, error_type='RESOURCE_BUSY')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The ResourceBusy exception indicates that the method could not be +completed because a resource it needs is busy.

+

Examples:

+
    +

  • Trying to power off a virtual machine that is in the process of being +powered on.

    • +
+

Counterexamples:

+
    +

  • Trying to remove a VMFS datastore when there is a virtual machine +registered on any host attached to the datastore. The +ResourceInUse exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.ResourceInUse(messages=None, data=None, error_type='RESOURCE_IN_USE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The ResourceInUse exception indicates that the method could not be +completed because a resource is in use.

+

Examples:

+
    +

  • Trying to remove a VMFS datastore when the is a virtual machine +registered on any host attached to the datastore.

    • +

  • Trying to add a virtual switch if the physical network adapter being +bridged is already in use.

    • +
+

Counterexamples:

+
    +

  • Trying to power off a virtual machine that is in the process of being +powered on. The ResourceBusy exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.ResourceInaccessible(messages=None, data=None, error_type='RESOURCE_INACCESSIBLE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The ResourceInaccessible exception indicates that the method could not +be completed because an entity is not accessible.

+

Examples:

+
    +

  • Attempt to invoke some method on a virtual machine when the virtual +machine’s configuration file is not accessible (for example due to a +storage APD condition).

    • +
+

Counterexamples:

+
    +

  • Attempt to invoke some method when the server is too busy. The +ServiceUnavailable exception would be used instead.

    • +

  • Attempt to invoke some method when the server is undergoing maintenance. +The ServiceUnavailable exception would be used instead.

    • +

  • Some method fails to contact VMware Tools running inside the virtual +machine. The ServiceUnavailable exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.ServiceUnavailable(messages=None, data=None, error_type='SERVICE_UNAVAILABLE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The ServiceUnavailable exception indicates that the class is +unavailable.

+

Examples:

+
    +

  • Attempt to invoke a method when the server is too busy.

    • +

  • Attempt to invoke a method when the server is undergoing maintenance.

    • +

  • An method fails to contact VMware Tools running inside the virtual +machine.

    • +
+

Counterexamples:

+
    +

  • A client provides an invalid service or operation identifier when +invoking the method using a dynamic interface (for example REST). The +OperationNotFound exception would be used instead.

    • +

  • A client invokes the method from the class, but that class has not been +installed. The OperationNotFound exception would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std.errors_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.TimedOut(messages=None, data=None, error_type='TIMED_OUT')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The TimedOut exception indicates that the method did not complete +within the allowed amount of time. The allowed amount of time might be:

+
    +

  • provided by the client as an input parameter.

    • +

  • a fixed limit of the class implementation that is a documented part of +the contract of the class.

    • +

  • a configurable limit used by the implementation of the class.

    • +

  • a dynamic limit computed by the implementation of the class.

    • +
+

The method may or may not complete after the TimedOut exception was +reported.

+

Examples:

+
    +

  • The method was unable to complete within the timeout duration specified +by a parameter of the method.

    • +
+

Counterexamples:

+
    +

  • A server implementation that puts requests into a queue before +dispatching them might delete a request from the queue if it doesn’t get +dispatched within n minutes. The ServiceUnavailable exception +would be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+class com.vmware.vapi.std.errors_client.TransientIndication(is_transient=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TransientIndication class indicates whether or not the exception is +transient.

+

Some types of exceptions are transient in certain situtations and not +transient in other situtations. This exception payload can be used to +indicate to clients whether a particular exception is transient. See +Error.data.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

is_transient (bool) – Indicates that the exception this class is attached to is +transient.

+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.UnableToAllocateResource(messages=None, data=None, error_type='UNABLE_TO_ALLOCATE_RESOURCE')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The UnableToAllocateResource exception indicates that the method failed +because it was unable to allocate or acquire a required resource.

+

Examples:

+
    +

  • Trying to power on a virtual machine when there are not enough licenses +to do so.

    • +

  • Trying to power on a virtual machine that would violate a resource usage +policy.

    • +
+

Counterexamples:

+
    +

  • Trying to power off a virtual machine that is in the process of being +powered on. A ResourceBusy exception would be used instead.

    • +

  • Trying to remove a VMFS datastore when the is a virtual machine +registered on any host attached to the datastore. The +ResourceInUse exception would be used instead.

    • +

  • Trying to add a virtual switch if the physical network adapter being +bridged is already in use. The ResourceInUse exception would be +used instead.

    • +

  • Attempt to invoke some method on a virtual machine when the virtual +machine’s configuration file is not accessible (for example due to a +storage APD condition). The ResourceInaccessible exception would +be used instead.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.Unauthenticated(messages=None, data=None, error_type='UNAUTHENTICATED', challenge=None)
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The Unauthenticated exception indicates that the method requires +authentication and the user is not authenticated.

+

API requests may include a security context containing user credentials. +For example, the user credentials could be a SAML token, a user name and +password, or the session identifier for a previously established session.

+

Examples:

+
    +

  • The SAML token in the request’s security context has expired.

    • +

  • The user name and password in the request’s security context are invalid.

    • +

  • The session identifier in the request’s security context identifies a +session that has expired.

    • +
+

Counterexamples:

+
    +

  • The user is authenticated but isn’t authorized to perform the requested +method. The Unauthorized exception would be used instead.

    • +
+

For security reasons, the Error.data attribute in this exception is +None, and the Error.messages attribute in this exception does not +disclose which part of the security context is correct or incorrect. For +example the messages would not disclose whether a username or a password is +valid or invalid, but only that a combination of username and password is +invalid.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +

  • challenge (str) –

    Indicates the authentication challenges applicable to the target +API provider. It can be used by a client to discover the correct +authentication scheme to use. The exact syntax of the value is +defined by the specific provider, the protocol and authentication +schemes used.

    +

    For example, a provider using REST may adhere to the +WWW-Authenticate HTTP header specification, RFC7235, section 4.1. +In this case an example challenge value may be: SIGN +realm=”27da1358-2ba4-11e9-b210-d663bd873d93”,sts=”http://vcenter/sso?vsphere.local”, +Basic realm=”vCenter”. This attribute was added in vSphere API +7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    +

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.Unauthorized(messages=None, data=None, error_type='UNAUTHORIZED')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The Unauthorized exception indicates that the user is not authorized to +perform the method.

+

API requests may include a security context containing user credentials. +For example, the user credentials could be a SAML token, a user name and +password, or the session identifier for a previously established session. +Invoking the method may require that the user identified by those +credentials has particular privileges on the method or on one or more +resource identifiers passed to the method.

+

Examples:

+
    +

  • The method requires that the user have one or more privileges on the +method, but the user identified by the credentials in the security context +does not have the required privileges.

    • +

  • The method requires that the user have one or more privileges on a +resource identifier passed to the method, but the user identified by the +credentials in the security context does not have the required privileges.

    • +
+

Counterexamples:

+
    +

  • The SAML token in the request’s security context has expired. A +Unauthenticated exception would be used instead.

    • +

  • The user name and password in the request’s security context are invalid. +The Unauthenticated exception would be used instead.

    • +

  • The session identifier in the request’s security context identifies a +session that has expired. The Unauthenticated exception would be +used instead.

    • +
+

For security reasons, the Error.data attribute in this exception is +None, and the Error.messages attribute in this exception does not +disclose why the user is not authorized to perform the method. For example +the messages would not disclose which privilege the user did not have or +which resource identifier the user did not have the required privilege to +access. The API documentation should indicate what privileges are required.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.UnexpectedInput(messages=None, data=None, error_type='UNEXPECTED_INPUT')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The UnexpectedInput exception indicates that the request contained a +parameter or attribute whose name is not known by the server.

+

Every method expects parameters with known names. Some of those parameters +may be (or contain) classes, and the method expects those classes to +contain attributes with known names. If the method receives parameters or +attributes with names that is does not expect, this exception may be +reported.

+

This exception can be reported by the API infrastructure for any method, +but it is specific to the API infrastructure, and should never be reported +by the implementation of any method.

+

Examples:

+
    +

  • A client using stubs generated from the interface specification for +version2 of a class invokes the method passing one or more parameters that +were added in version2, but they are communicating with a server that only +supports version1 of the class.

    • +

  • A client provides an unexpected parameter or attribute name when invoking +the method using a dynamic interface (for example REST).

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.Unsupported(messages=None, data=None, error_type='UNSUPPORTED')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The Unsupported exception indicates that the method is not supported by +the class.

+

Examples:

+
    +

  • Trying to hot-plug a CPU when the current configuration of the VM does +not support hot-plugging of CPUs.

    • +

  • Trying to change the memory size to a value that is not within the +acceptable guest memory bounds supported by the virtual machine’s host.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+exception com.vmware.vapi.std.errors_client.UnverifiedPeer(messages=None, data=None, error_type='UNVERIFIED_PEER')
+

Bases: com.vmware.vapi.std.errors_client.Error

+

The UnverifiedPeer exception indicates that an attempt to connect to an +unknown or not-yet-trusted endpoint failed because the system was unable to +verify the identity of the endpoint.

+

Typically the Error.data attribute of this error will contain +information that can be presented to a human to allow them to decide +whether to trust the endpoint. If they decide to trust the endpoint, the +request can be resubmitted with an indication that the endpoint should be +trusted.

+

Examples:

+
    +

  • The client provides an IP address or URL of an endpoint the system should +communicate with using an SSL connection, but the endpoint’s SSL +certificate is self-signed, expired, or otherwise not trustworthy.

    • +

  • The client provides an IP address of a host the system should communicate +with using ssh, but ssh doesn’t recognize the public key of the host

    • +
+

. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked.

    +

    Each subsequent message in the stack describes the “cause” of the +prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports.

    +

    The ArgumentLocations, FileLocations, and +TransientIndication classes are intended as possible +values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +

  • error_type (Error.Type) – Discriminator field to help API consumers identify the structure +type. This attribute was added in vSphere API 6.7.2. +Can be None for compatibility with preceding implementations.

    • +
+
+
+
+ +
+
+

com.vmware.vapi.std.routing_client module

+

The com.vmware.vapi.metadata.routing_client module provides classes that +expose routing information for operation elements across all the service +elements.

+
+
+class com.vmware.vapi.std.routing_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.authorization.html b/vsphere/8.0.2.0/com.vmware.vcenter.authorization.html new file mode 100644 index 00000000..d3b9f797 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.authorization.html @@ -0,0 +1,192 @@ + + + + + + + com.vmware.vcenter.authorization package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.authorization package

+
+

Submodules

+
+
+

com.vmware.vcenter.authorization.privilege_checks_client module

+
+
+class com.vmware.vcenter.authorization.privilege_checks_client.Latest(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LatestPrivilegeChecks class provides methods for getting the latest +recorded privilege check. This class was added in vSphere API 8.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Returns a marker to the last recorded privilege check. This method was +added in vSphere API 8.0.0.0.

+
+
Return type
+

str

+
+
Returns
+

A marker for the most recently recorded privilege check.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Sessions.CollectPrivilegeChecks.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.authorization.privilege_checks_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.certificate_management.html b/vsphere/8.0.2.0/com.vmware.vcenter.certificate_management.html new file mode 100644 index 00000000..25741fe5 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.certificate_management.html @@ -0,0 +1,993 @@ + + + + + + + com.vmware.vcenter.certificate_management package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.certificate_management package

+
+

Submodules

+
+
+

com.vmware.vcenter.certificate_management.vcenter_client module

+

The com.vmware.vcenter.certificate_management.vcenter_client module +provides classes to manage certificates.

+
+
+class com.vmware.vcenter.certificate_management.vcenter_client.SigningCertificate(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SigningCertificate interface provides methods to view and manage +vCenter signing certificates which are used to sign and verify tokens +issued by vCenter token service. Versioning is the same as for the +com.vmware.vcenter package. 1.23 - vSphere 7.0 U3. This class was added in +vSphere API 7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(active_cert_chain=None, signing_cert_chains=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SigningCertificate.Info class contains data that represents vCenter +signing certificates. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • active_cert_chain (com.vmware.vcenter.certificate_management_client.X509CertChain) – The certificate chain that is actively being use by vCenter token +service to sign tokens. This attribute was added in vSphere API +7.0.3.0.

    • +

  • signing_cert_chains (list of com.vmware.vcenter.certificate_management_client.X509CertChain) – List of signing certificate chains for validating vCenter-issued +tokens. The list contains X509 certificate chains, each of which is +ordered and contains the leaf, intermediate and root certs needed +for the complete chain of trust. The leaf certificate is first in +the chain and should be used for verifying vCenter-issued tokens. +This attribute was added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class SetSpec(signing_cert_chain=None, private_key=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SigningCertificate.SetSpec class contains data to set the active +vCenter signing certificate. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • signing_cert_chain (com.vmware.vcenter.certificate_management_client.X509CertChain) – Signing certificate chain that the vCenter token service will +actively use to sign tokens. The chain must include a valid +certificate chain with the leaf cert marked for digital signature +key usage. This attribute was added in vSphere API 7.0.3.0.

    • +

  • private_key (str) – The corresponding unencrypted PKCS#8 private key in base64-encoded +PEM format. This attribute was added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+get()
+

Retrieve the signing certificate chains for validating vCenter-issued +tokens. This method was added in vSphere API 7.0.3.0.

+
+
Return type
+

SigningCertificate.Info

+
+
Returns
+

The active certificate chain and signing certificate chains for +validating tokens.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+refresh(force=None)
+

Refresh the vCenter signing certificate chain. The new signing +certificate will be issued in accordance with vCenter CA policy and set +as the active signing certificate for the vCenter token service. The +certificate will immediately be used to sign tokens issued by vCenter +token service. If a third-party/custom certificate has been configured +as the signing certificate for compliance reasons, refresh may take +vCenter out of compliance. This method was added in vSphere API +7.0.3.0.

+
+
Parameters
+

force (bool or None) – Will force refresh in environments that would otherwise prevent +refresh from occurring, such as a mixed-version environment. Force +refresh may leave systems in the local vCenter domain in a +non-functional state until they are restarted. +If None, then refresh will not be forced.

+
+
Return type
+

com.vmware.vcenter.certificate_management_client.X509CertChain

+
+
Returns
+

The signing certificate chain created during the refresh.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Administer.

    • +
+
+
+
+ +
+
+set(spec)
+

Set the active signing certificate for vCenter. The certificate will +immediately be used to sign tokens issued by vCenter token service. +This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

spec (SigningCertificate.SetSpec) – Signing certificate chain and private key which the vCenter token +service will actively use to sign tokens.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Administer.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.certificate_management.vcenter_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.certificate_management.vcenter_client.Tls(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Tls interface provides methods to replace Tls certificate. This +class was added in vSphere API 6.7.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(version=None, serial_number=None, signature_algorithm=None, issuer_dn=None, valid_from=None, valid_to=None, subject_dn=None, thumbprint=None, is_ca=None, path_length_constraint=None, key_usage=None, extended_key_usage=None, subject_alternative_name=None, authority_information_access_uri=None, cert=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tls.Info class contains information from a TLS certificate. This +class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (long) – Version (version number) value from the certificate. This attribute +was added in vSphere API 6.7.2.

    • +

  • serial_number (str) – SerialNumber value from the certificate. This attribute was added +in vSphere API 6.7.2.

    • +

  • signature_algorithm (str) – Signature algorithm name from the certificate. This attribute was +added in vSphere API 6.7.2.

    • +

  • issuer_dn (str) – Issuer (issuer distinguished name) value from the certificate. This +attribute was added in vSphere API 6.7.2.

    • +

  • valid_from (datetime.datetime) – validFrom specify the start date of the certificate. This attribute +was added in vSphere API 6.7.2.

    • +

  • valid_to (datetime.datetime) – validTo specify the end date of the certificate. This attribute was +added in vSphere API 6.7.2.

    • +

  • subject_dn (str) – Subject (subject distinguished name) value from the certificate. +This attribute was added in vSphere API 6.7.2.

    • +

  • thumbprint (str) – Thumbprint value from the certificate. This attribute was added in +vSphere API 6.7.2.

    • +

  • is_ca (bool) – Certificate constraints isCA from the critical BasicConstraints +extension, (OID = 2.5.29.19). This attribute was added in vSphere +API 6.7.2.

    • +

  • path_length_constraint (long) – Certificate constraints path length from the critical +BasicConstraints extension, (OID = 2.5.29.19). This attribute was +added in vSphere API 6.7.2.

    • +

  • key_usage (list of str) – Collection of keyusage contained in the certificate. This attribute +was added in vSphere API 6.7.2.

    • +

  • extended_key_usage (list of str) – Collection of extended keyusage that contains details for which the +certificate can be used for. This attribute was added in vSphere +API 6.7.2.

    • +

  • subject_alternative_name (list of str) – Collection of subject alternative names. This attribute was added +in vSphere API 6.7.2.

    • +

  • authority_information_access_uri (list of str) – Collection of authority information access URI. This attribute was +added in vSphere API 6.7.2.

    • +

  • cert (str) – TLS certificate in PEM format. This attribute was added in vSphere +API 6.7.2.

    • +
+
+
+
+ +
+
+class ReplaceSpec(key_size=None, common_name=None, organization=None, organization_unit=None, locality=None, state_or_province=None, country=None, email_address=None, subject_alt_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tls.ReplaceSpec class contains information to generate a Private +Key , CSR and hence VMCA signed machine SSL. This class was added in +vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key_size (long or None) – The size of the key to be used for public and private key +generation. This attribute was added in vSphere API 6.7.2. +If None the key size will be ‘3072’.

    • +

  • common_name (str or None) – The common name of the host for which certificate is generated. +This attribute was added in vSphere API 6.7.2. +If None will default to PNID of host.

    • +

  • organization (str) – Organization field in certificate subject. This attribute was added +in vSphere API 6.7.2.

    • +

  • organization_unit (str) –

    Organization unit field in certificate subject.

    +

    CA Browser forum announced that “CAs MUST NOT include the +organizationalUnitName field”. So OU is no longer needed and an +empty string should be used to leave it unset.. This attribute was +added in vSphere API 6.7.2.

    +

    • +

  • locality (str) – Locality field in certificate subject. This attribute was added in +vSphere API 6.7.2.

    • +

  • state_or_province (str) – State field in certificate subject. This attribute was added in +vSphere API 6.7.2.

    • +

  • country (str) – Country field in certificate subject. This attribute was added in +vSphere API 6.7.2.

    • +

  • email_address (str) – Email field in Certificate extensions. This attribute was added in +vSphere API 6.7.2.

    • +

  • subject_alt_name (list of str or None) – SubjectAltName is list of Dns Names and Ip addresses. This +attribute was added in vSphere API 6.7.2. +If None PNID of host will be used as IPAddress or Hostname for +certificate generation .

    • +
+
+
+
+ +
+
+class Spec(cert=None, key=None, root_cert=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tls.Spec class contains information for a Certificate and Private +Key. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cert (str) – Certificate string in PEM format. This attribute was added in +vSphere API 6.7.2.

    • +

  • key (str or None) – Private key string in PEM format. This attribute was added in +vSphere API 6.7.2. +If None the private key from the certificate store will be used. It +is required when replacing the certificate with a third party +signed certificate.

    • +

  • root_cert (str or None) – 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.

    • +
+
+
+
+ +
+
+get()
+

Returns the rhttpproxy TLS certificate. This method was added in +vSphere API 6.7.2.

+
+
Return type
+

Tls.Info

+
+
Returns
+

TLS certificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the rhttpproxy certificate is not present in VECS store.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if failed due to generic exception.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+renew(duration=None)
+

Renews the TLS certificate for the given duration period.

+

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.

+
+
Parameters
+

duration (long or None) – The duration (in days) of the new TLS certificate. The duration +should be less than or equal to 730 days. +If None, the duration will be 730 days (two years).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the TLS certificate is not VMCA generated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the duration period specified is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system failed to renew the TLS certificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Administer.

    • +
+
+
+
+ +
+
+replace_vmca_signed(spec)
+

Replace MACHINE SSL with VMCA signed one with the given Spec.The system +will go for restart.

+

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.

+
+
Parameters
+

spec (Tls.ReplaceSpec) – The information needed to generate VMCA signed Machine SSL

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the Spec given is not complete or invalid

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system failed to replace the machine ssl certificate

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Administer.

    • +
+
+
+
+ +
+
+set(spec)
+

Replaces the rhttpproxy TLS certificate with the specified certificate. +This method can be used in three scenarios :

+
    +

  1. When the CSR is created and the private key is already stored, this +method can replace the certificate. The Tls.Spec.cert (but not +Tls.Spec.key and Tls.Spec.root_cert) must be provided +as input.

    2. +

  2. When the certificate is signed by a third party certificate +authority/VMCA and the root certificate of the third party certificate +authority/VMCA is already one of the trusted roots in the trust store, +this method can replace the certificate and private key. The +Tls.Spec.cert and Tls.Spec.key (but not +Tls.Spec.root_cert) must be provided as input.

    3. +

  3. When the certificate is signed by a third party certificate +authority and the root certificate of the third party certificate +authority is not one of the trusted roots in the trust store, this +method can replace the certificate, private key and root CA +certificate. The Tls.Spec.cert,:attr:Tls.Spec.key and +Tls.Spec.root_cert must be provided as input.

    4. +
+

After this method completes, the services using the certificate will 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.

+
+
Parameters
+

spec (Tls.Spec) – The information needed to replace the TLS certificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the private key is not present in the VECS store.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If the specified certificate thumbprint is the same as the existing +TLS certificate thumbprint.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system failed to replace the TLS certificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Administer.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TlsCsr interface provides methods to generate certificate signing +request. This class was added in vSphere API 6.7.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(csr=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TlsCsr.Info class contains information for a Certificate signing +request. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

csr (str) – Certificate Signing Request in PEM format. This attribute was added +in vSphere API 6.7.2.

+
+
+
+ +
+
+class Spec(key_size=None, common_name=None, organization=None, organization_unit=None, locality=None, state_or_province=None, country=None, email_address=None, subject_alt_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TlsCsr.Spec class contains information to generate a Private Key +and CSR. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key_size (long or None) – The size of the key to be used for public and private key +generation. This attribute was added in vSphere API 6.7.2. +If None, the key size will be 3072 bits.

    • +

  • common_name (str or None) – Common name field in certificate subject. This attribute was added +in vSphere API 6.7.2. +If None, the common name will be the PNID.

    • +

  • organization (str) – Organization field in certificate subject. This attribute was added +in vSphere API 6.7.2.

    • +

  • organization_unit (str) –

    Organization unit field in certificate subject.

    +

    CA Browser forum announced that “CAs MUST NOT include the +organizationalUnitName field”. So OU is no longer needed and an +empty string should be used to leave it unset.. This attribute was +added in vSphere API 6.7.2.

    +

    • +

  • locality (str) – Locality field in certificate subject. This attribute was added in +vSphere API 6.7.2.

    • +

  • state_or_province (str) – State field in certificate subject. This attribute was added in +vSphere API 6.7.2.

    • +

  • country (str) – Country field in certificate subject. This attribute was added in +vSphere API 6.7.2.

    • +

  • email_address (str) – Email field in Certificate extensions. This attribute was added in +vSphere API 6.7.2.

    • +

  • subject_alt_name (list of str or None) – Subject Alternative Name field is list of Dns Names and Ip +addresses. This attribute was added in vSphere API 6.7.2. +If None, the subject alternative name will contain the PNID.

    • +
+
+
+
+ +
+
+create(spec)
+

Generates a CSR with the given Spec. This method was added in vSphere +API 6.7.2.

+
+
Parameters
+

spec (TlsCsr.Spec) – The information needed to create a CSR.

+
+
Return type
+

TlsCsr.Info

+
+
Returns
+

A Certificate Signing Request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If CSR could not be created for given spec for a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Manage and +CertificateManagement.Administer.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TrustedRootChains interface provides methods to create, modify, +delete and read trusted root certificate chains. This class was added in +vSphere API 6.7.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(cert_chain=None, chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedRootChains.CreateSpec class contains information to create a +trusted root certificate chain. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cert_chain (com.vmware.vcenter.certificate_management_client.X509CertChain) – Certificate chain in base64 encoding. This attribute was added in +vSphere API 6.7.2.

    • +

  • chain (str or None) – Unique identifier for this trusted root. Client can specify at +creation as long as it is unique, otherwise one will be generated. +An example of a client providing the identifier would be if this +trusted root is associated with a VC trust. In this case the +identifier would be the domain id. This attribute was added in +vSphere API 6.7.2. +A unique id will be generated if not given.

    • +
+
+
+
+ +
+
+class Info(cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedRootChains.Info class contains information for a trusted +root certificate chain. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

cert_chain (com.vmware.vcenter.certificate_management_client.X509CertChain) – A certificate chain in base64 encoding. This attribute was added in +vSphere API 6.7.2.

+
+
+
+ +
+
+class Summary(chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedRootChains.Summary class contains a trusted root certificate +chain summary suitable for UI presentation. This class was added in vSphere +API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

chain (str) – Unique identifier for chain. This attribute was added in vSphere +API 6.7.2.

+
+
+
+ +
+
+create(spec)
+

Creates a new trusted root certificate chain from the CreateSpec. This +method was added in vSphere API 6.7.2.

+
+
Parameters
+

spec (TrustedRootChains.CreateSpec) – The information needed to create a trusted root certificate chain.

+
+
Return type
+

str

+
+
Returns
+

The unique identifier for the new trusted root chain.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a trusted root certificate chain exists with id in given spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Manage and +CertificateManagement.Administer.

    • +
+
+
+
+ +
+
+delete(chain)
+

Deletes trusted root certificate chain for a given identifier. This +method was added in vSphere API 6.7.2.

+
+
Parameters
+

chain (str) – Unique identifier for a trusted root cert chain.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a trusted root certificate chain does not exist for given id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Manage and +CertificateManagement.Administer.

    • +
+
+
+
+ +
+
+get(chain)
+

Retrieve a trusted root certificate chain for a given identifier. This +method was added in vSphere API 6.7.2.

+
+
Parameters
+

chain (str) – Unique identifier for a trusted root cert chain.

+
+
Return type
+

TrustedRootChains.Info

+
+
Returns
+

TrustedRootChain.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a trusted root certificate chain does not exist for given id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns summary information for each trusted root certificate chain. +This method was added in vSphere API 6.7.2.

+
+
Return type
+

list of TrustedRootChains.Summary

+
+
Returns
+

List of trusted root certificate chains summaries.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The VmcaRoot interface provides methods to replace VMware Certificate +Authority (VMCA) root certificate. This class was added in vSphere API +6.9.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(key_size=None, common_name=None, organization=None, organization_unit=None, locality=None, state_or_province=None, country=None, email_address=None, subject_alt_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VmcaRoot.CreateSpec contains information. to generate a Private Key +and CSR. This class was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key_size (long or None) – 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 3072.

    • +

  • common_name (str or None) – 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).

    • +

  • organization (str or None) – Organization field in certificate subject. This attribute was added +in vSphere API 6.9.1. +If None the organization will be ‘VMware’.

    • +

  • organization_unit (str or None) – Organization unit field in certificate subject. This attribute was +added in vSphere API 6.9.1. +If None the organization unit will not be set in the certificate +subject.

    • +

  • locality (str or None) – Locality field in certificate subject. This attribute was added in +vSphere API 6.9.1. +If None the locality will be ‘Palo Alto’.

    • +

  • state_or_province (str or None) – State field in certificate subject. This attribute was added in +vSphere API 6.9.1. +If None the state will be ‘California’.

    • +

  • country (str or None) – Country field in certificate subject. This attribute was added in +vSphere API 6.9.1. +If None the country will be ‘US’.

    • +

  • email_address (str or None) – Email field in Certificate extensions. This attribute was added in +vSphere API 6.9.1. +If None the emailAddress will be ‘email\@acme.com’.

    • +

  • subject_alt_name (list of str or None) – 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.

    • +
+
+
+
+ +
+
+create(spec=None)
+

Replace Root Certificate with VMCA signed one using the given Spec.

+

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.

+
+
Parameters
+

spec (VmcaRoot.CreateSpec or None) – The information needed to generate VMCA signed Root Certificate. +Default values will be set for all null parameters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the system failed to renew the TLS certificate.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the operation is executed on a platform where it is not +supported. This exception was added in vSphere API 8.0.2.0.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires CertificateManagement.Administer.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.compute.html b/vsphere/8.0.2.0/com.vmware.vcenter.compute.html new file mode 100644 index 00000000..c0392083 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.compute.html @@ -0,0 +1,616 @@ + + + + + + + com.vmware.vcenter.compute package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.compute package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.compute.policies_client module

+

The com.vmware.vcenter.compute.policies_client module provides classes for +managing compute policies.

+
+
+class com.vmware.vcenter.compute.policies_client.Capabilities(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Capabilities class provides methods to manage compute policy +capabilities. The description of the capability provides information about +the intent of a policy based on this capability. A capability provides a +type to create a policy (see +com.vmware.vcenter.compute_client.Policies.create()). A capability +also provides a type that describes the information returned when +retrieving information about a policy (see +com.vmware.vcenter.compute_client.Policies.get()).

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(name=None, description=None, create_spec_type=None, info_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Capabilities.Info class contains information about a compute policy +capability.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the capability.

    • +

  • description (str) – Description of the capability.

    • +

  • create_spec_type (str) – Identifier of the class used to create a policy based on this +capability. See +com.vmware.vcenter.compute_client.Policies.create(). +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure.

    • +

  • info_type (str) – Identifier of the class returned when retrieving information about +a policy based on this capability. See +com.vmware.vcenter.compute_client.Policies.get(). +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.compute.policies.Capability'
+

The resource type for the compute policy capability.

+
+ +
+
+class Summary(capability=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Capabilities.Summary class contains commonly used information about +a compute policy capability.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • capability (str) – Identifier of the capability. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the capability.

    • +

  • description (str) – Description of the capability.

    • +
+
+
+
+ +
+
+get(capability)
+

Returns information about a specific compute policy capability.

+
+
Parameters
+

capability (str) – Identifier of the capability for which information should be +retrieved. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

+
+
Return type
+

Capabilities.Info

+
+
Returns
+

Detailed information about the capability.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a capability with this identifier does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns information about the compute policy capabilities available in +this vCenter server.

+
+
Return type
+

list of Capabilities.Summary

+
+
Returns
+

The list of compute policy capabilities available on this vCenter +server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies_client.CreateSpec(capability=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains common information used to create a new +policy.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies_client.Info(name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains common information about a compute policy.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies_client.ObjectCompliance(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ObjectCompliance class defines the compliance states a policy can +be in on a particular object.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ObjectCompliance instance.

+
+
+
+
+COMPLIANT = ObjectCompliance(string='COMPLIANT')
+

The policy is in compliance on the object.

+
+ +
+
+NOT_APPLICABLE = ObjectCompliance(string='NOT_APPLICABLE')
+

The object is in a state for which the policy does not apply.

+
+ +
+
+NOT_COMPLIANT = ObjectCompliance(string='NOT_COMPLIANT')
+

The policy is not in compliance on the object.

+
+ +
+
+UNKNOWN = ObjectCompliance(string='UNKNOWN')
+

The object has an unknown compliance state.

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies_client.Status(status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Status class describes the current status of a compute policy.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

status (ObjectCompliance) – The compliance status of the policy on a specified object.

+
+
+
+ +
+
+class com.vmware.vcenter.compute.policies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.compute.policies_client.TagUsage(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TagUsage class provides methods to query which tags are used by +policies.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(policies=None, tags=None, tag_types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TagUsage.FilterSpec class contains attributes used to filter the +results when listing the tags used by policies as available in this vCenter +server (see TagUsage.list()). If multiple attributes are specified, +only the tags used by policies that match an element of each attribute +match the filter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policies (set of str or None) – Identifiers that compute policies must have to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.compute.Policy. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.compute.Policy. +If None or empty, then tags used by any policy match this filter.

    • +

  • tags (set of str or None) – Identifiers that tags must have to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.cis.tagging.Tag. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.cis.tagging.Tag. +If None or empty, then tags with any tag identifier match this +filter.

    • +

  • tag_types (set of str or None) – Identifiers that tag types must have to match the filter. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vapi.resource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.vapi.resource. +If None or empty, then tags of any type match this filter.

    • +
+
+
+
+ +
+
+class Summary(policy=None, tag_type=None, tag=None, tag_name=None, category_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TagUsage.Summary class contains common information about a tag used +by a policy.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Identifier of the policy that uses the tag indicated by +TagUsage.Summary.tag. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.Policy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.compute.Policy.

    • +

  • tag_type (str) – Identifier of the tag type used by the policy indicated by +TagUsage.Summary.policy. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.resource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.resource.

    • +

  • tag (str) – Identifier of the tag used by the policy indicated by +TagUsage.Summary.policy. +When clients pass a value of this class as a parameter, the +attribute tagType must contain the actual resource type. When +methods return a value of this class as a return value, the +attribute tagType will contain the actual resource type.

    • +

  • tag_name (str) – Name of the tag used by the policy indicated by +TagUsage.Summary.policy.

    • +

  • category_name (str) – Name of the category that has TagUsage.Summary.tag.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns information about the tags used by policies available in this +vCenter server matching the TagUsage.FilterSpec.

+
+
Parameters
+

filter (TagUsage.FilterSpec or None) – Specification for matching tags used by policies. +If None, the behavior is equivalent to a +TagUsage.FilterSpec with all attributes None, which means +all tags used by policies match the filter.

+
+
Return type
+

list of TagUsage.Summary

+
+
Returns
+

The list of tags used by policies available on this vCenter server +matching the TagUsage.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.html b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.html new file mode 100644 index 00000000..2f0c965f --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.html @@ -0,0 +1,1075 @@ + + + + + + + com.vmware.vcenter.compute.policies.capabilities package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.compute.policies.capabilities package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module

+

The +com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client +module provides classes for the Scale-In Ignore Virtual Machine Capabilities +capability offered by vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud +on AWS is not supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.CreateSpec(vm_tag=None, vm_capabilities=None, capability='com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new policy +to ignore virtual machine capabilities when scaling-in a cluster, see +com.vmware.vcenter.compute_client.Policies.create(). When considering +scaling-in a cluster, policies that have been created with one of the +listed CreateSpec.vm_capabilities are ignored for virtual machines +that have the tag indicated by CreateSpec.vm_tag in VMware Cloud on +AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – When considering scaling-in a cluster, policies that have been +created with one of the listed CreateSpec.vm_capabilities +are ignored for virtual machines that have this tag. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • vm_capabilities (set of str) – When considering scaling-in a cluster, policies that have been +created with one of these capabilities are ignored for virtual +machines that have the tag indicated by CreateSpec.vm_tag. +This set must contain at least one item. Currently, the +only allowed capability identifier is +com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client. +In the future, other capabilities may be specified. Warning: +This attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.compute.policies.Capability:VirtualMachine. +When methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.compute.policies.Capability:VirtualMachine.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.Info(vm_tag=None, vm_capabilities=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a policy to ignore virtual +machine capabilities when scaling-in a cluster, see +com.vmware.vcenter.compute_client.Policies.get(). When considering +scaling-in a cluster, policies that have been created with one of the +listed Info.vm_capabilities are ignored for virtual machines that +have the tag indicated by Info.vm_tag in VMware Cloud on AWS. Usage +beyond VMware Cloud on AWS is not supported. Warning: This class is +available as Technology Preview. These are early access APIs provided to +test, automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards compatibility and +recommends against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – When considering scaling-in a cluster, policies that have been +created with one of the listed Info.vm_capabilities are +ignored for virtual machines that have this tag. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • vm_capabilities (set of str) – When considering scaling-in a cluster, policies that have been +created with one of these capabilities are ignored for virtual +machines that have the tag indicated by Info.vm_tag. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.compute.policies.Capability:VirtualMachine. +When methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.compute.policies.Capability:VirtualMachine.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module

+

The +com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client +module provides classes for the Disable DRS vMotion capability offered by +vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not +supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new +DisableDrsVmotion policy, see +com.vmware.vcenter.compute_client.Policies.create(), in VMware Cloud +on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will not be migrated away from the +host on which they are powered on, except when the host is put into +maintenance mode or failed over. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info(vm_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a DisableDrsVmotion policy, +see com.vmware.vcenter.compute_client.Policies.get() in VMware Cloud +on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will not be migrated away from the +host on which they are powered on, except when the host is put into +maintenance mode or failed over. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module

+

The +com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client +module provides classes for the VM Host affinity capability offered by vCenter +in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.CreateSpec(vm_tag=None, host_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new virtual +machine to host affinity policy, see +com.vmware.vcenter.compute_client.Policies.create(). Virtual machines +that have the tag indicated by CreateSpec.vm_tag will be affine to +hosts that have the tag indicated by CreateSpec.host_tag in VMware +Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. +Warning: This class is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable to +specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be affine to the hosts +indicated by CreateSpec.host_tag. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • host_tag (str) – Identifier of a tag that can be associated with a host. Virtual +machines indicated by CreateSpec.vm_tag will be affine to +hosts with this tag. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.Info(vm_tag=None, host_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a virtual machine to host +affinity policy, see +com.vmware.vcenter.compute_client.Policies.get(). Virtual machines +that have the tag indicated by Info.vm_tag will be affine to hosts +that have the tag indicated by Info.host_tag in VMware Cloud on +AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This +class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be affine to the hosts +indicated by Info.host_tag. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • host_tag (str) – Identifier of a tag that can be associated with a host. Virtual +machines indicated by Info.vm_tag will be affine to hosts +with this tag. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module

+

The +com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client +module provides classes for the VM Host anti-affinity capability offered by +vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not +supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec(vm_tag=None, host_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new virtual +machine to host anti-affinity policy, see +com.vmware.vcenter.compute_client.Policies.create(). Virtual machines +that have the tag indicated by CreateSpec.vm_tag will be +anti-affine to hosts that have the tag indicated by +CreateSpec.host_tag in VMware Cloud on AWS. Usage beyond VMware +Cloud on AWS is not supported. Warning: This class is available as +Technology Preview. These are early access APIs provided to test, automate +and provide feedback on the feature. Since this can change based on +feedback, VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology Preview APIs +might only be applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be anti-affine to the hosts +indicated by CreateSpec.host_tag. Warning: This +attribute is available as Technology Preview. These are early +access APIs provided to test, automate and provide feedback on the +feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them +in production environments. Some Technology Preview APIs might only +be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • host_tag (str) – Identifier of a tag that can be associated with a host. Virtual +machines indicated by CreateSpec.vm_tag will be anti-affine +to hosts with this tag. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info(vm_tag=None, host_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a virtual machine to host +anti-affinity policy, see +com.vmware.vcenter.compute_client.Policies.get(). Virtual machines +that have the tag indicated by Info.vm_tag will be anti-affine to +hosts that have the tag indicated by Info.host_tag in VMware Cloud +on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: +This class is available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. Since this +can change based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production environments. +Some Technology Preview APIs might only be applicable to specific +environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be anti-affine to the hosts +indicated by Info.host_tag. Warning: This attribute is +available as Technology Preview. These are early access APIs +provided to test, automate and provide feedback on the feature. +Since this can change based on feedback, VMware does not guarantee +backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • host_tag (str) – Identifier of a tag that can be associated with a host. Virtual +machines indicated by Info.vm_tag will be anti-affine to +hosts with this tag. Warning: This attribute is available as +Technology Preview. These are early access APIs provided to test, +automate and provide feedback on the feature. Since this can change +based on feedback, VMware does not guarantee backwards +compatibility and recommends against using them in production +environments. Some Technology Preview APIs might only be applicable +to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:HostSystem.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module

+

The com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client +module provides classes for the VM-VM affinity capability offered by vCenter in +VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new VM-VM +affinity policy, see +com.vmware.vcenter.compute_client.Policies.create(). All virtual +machines that share the tag indicated by CreateSpec.vm_tag will be +affined to each other in VMware Cloud on AWS. Usage beyond VMware Cloud on +AWS is not supported. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be affined to each other. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info(vm_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a VM-VM affinity policy, see +com.vmware.vcenter.compute_client.Policies.get(). All virtual +machines that share the tag indicated by Info.vm_tag are affined to +each other in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not +supported. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be affined to each other. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module

+

The +com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client +module provides classes for the VM VM anti-affinity capability offered by +vCenter in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not +supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new VM-VM +anti-affinity policy, see +com.vmware.vcenter.compute_client.Policies.create(). All virtual +machines that share the tag indicated by CreateSpec.vm_tag will be +anti-affine to each other in VMware Cloud on AWS. Usage beyond VMware Cloud +on AWS is not supported. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be anti-affine to each other. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info(vm_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a VM-VM anti-affinity policy, +see com.vmware.vcenter.compute_client.Policies.get(). All virtual +machines that share the tag indicated by Info.vm_tag are +anti-affine to each other in VMware Cloud on AWS. Usage beyond VMware Cloud +on AWS is not supported. Warning: This class is available as Technology +Preview. These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, VMware +does not guarantee backwards compatibility and recommends against using +them in production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag are anti-affine to each other. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html new file mode 100644 index 00000000..a4ff25a9 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html @@ -0,0 +1,276 @@ + + + + + + + com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package

+
+

Submodules

+
+
+

com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new vMotion +policy that applies when a host is evacuated, see +com.vmware.vcenter.compute_client.Policies.create(), in VMware Cloud +on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual +machines that share the tag indicated by CreateSpec.vm_tag will be +vMotioned from a host whenever the host is evacuated by vCenter. If vCenter +cannot migrate a virtual machine, then it will remain running on its +current host. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be vMotioned from a host if +vCenter requires to evacuate the host. If vMotion is not feasible, +then the virtual machine will remain running on its current host. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info(vm_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a vMotion policy that applies +when a host is evacuated, see +com.vmware.vcenter.compute_client.Policies.get(), in VMware Cloud on +AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual +machines that share the tag indicated by Info.vm_tag will be +vMotioned from a host whenever the host is evacuated by vCenter. If vCenter +cannot migrate a virtual machine, then it will remain running on its +current host. Warning: This class is available as Technology Preview. +These are early access APIs provided to test, automate and provide feedback +on the feature. Since this can change based on feedback, VMware does not +guarantee backwards compatibility and recommends against using them in +production environments. Some Technology Preview APIs might only be +applicable to specific environments.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +Virtual machines with this tag will be vMotioned from a host if +vCenter requires to evacuate the host. If vMotion is not feasible, +then the virtual machine will remain running on its current host. +Warning: This attribute is available as Technology Preview. +These are early access APIs provided to test, automate and provide +feedback on the feature. Since this can change based on feedback, +VMware does not guarantee backwards compatibility and recommends +against using them in production environments. Some Technology +Preview APIs might only be applicable to specific environments. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.html b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.html new file mode 100644 index 00000000..b81fb1eb --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.html @@ -0,0 +1,190 @@ + + + + + + + com.vmware.vcenter.compute.policies.capabilities.vm package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.compute.policies.capabilities.vm package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.compute.policies.capabilities.vm.evacuation_client module

+

The com.vmware.vcenter.compute.policies.capabilities.vm.evacuation_client +module provides classes for the virtual machine evacuation capabilities offered +by vCenter.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.compute.policies.capabilities.vm.placement_client module

+

The com.vmware.vcenter.compute.policies.capabilities.vm.placement_client +module provides classes for the virtual machine placement capabilities offered +by vCenter.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.placement_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.placement.html b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.placement.html new file mode 100644 index 00000000..14b8a1cd --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.capabilities.vm.placement.html @@ -0,0 +1,250 @@ + + + + + + + com.vmware.vcenter.compute.policies.capabilities.vm.placement package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.compute.policies.capabilities.vm.placement package

+
+

Submodules

+
+
+

com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client module

+

The +com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client +module provides classes for anti-affinity with vSphere Cluster Services (vCLS) +VMs capability offered by vCenter.

+
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls', name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CreateSpec class contains information used to create a new +anti-affinity with vSphere Cluster Services (vCLS) VMs policy, see +com.vmware.vcenter.compute_client.Policies.create(). vSphere Cluster +Services (vCLS) VMs are anti-affine with virtual machines that share the +tag indicated by CreateSpec.vm_tag.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +vSphere Cluster Services (vCLS) VMs are anti-affine with virtual +machines that share the tag indicated by CreateSpec.vm_tag. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +

  • name (str) – Name of the policy. The name needs to be unique within this vCenter +server.

    • +

  • description (str) – Description of the policy.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client.Info(vm_tag=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about anti-affinity with vSphere +Cluster Services (vCLS) VMs policy, see +com.vmware.vcenter.compute_client.Policies.get(). vSphere Cluster +Services (vCLS) VMs are anti-affine with virtual machines that share the +tag indicated by Info.vm_tag.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. +vSphere Cluster Services (vCLS) VMs are anti-affine with virtual +machines that share the tag indicated by Info.vm_tag. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.cis.tagging.Tag:VirtualMachine.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+
+property capability
+

Return the discriminator value

+
+ +
+ +
+
+class com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.html b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.html new file mode 100644 index 00000000..df21db91 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.compute.policies.html @@ -0,0 +1,192 @@ + + + + + + + com.vmware.vcenter.compute.policies package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.compute.policies package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.compute.policies.capabilities_client module

+

The com.vmware.vcenter.compute.policies.capabilities_client module provides +classes for compute policy capabilities offered by vCenter in VMware Cloud on +AWS. Usage beyond VMware Cloud on AWS is not supported.

+
+
+class com.vmware.vcenter.compute.policies.capabilities_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.confidential_computing.html b/vsphere/8.0.2.0/com.vmware.vcenter.confidential_computing.html new file mode 100644 index 00000000..52bed4bb --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.confidential_computing.html @@ -0,0 +1,232 @@ + + + + + + + com.vmware.vcenter.confidential_computing package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.confidential_computing package

+
+

Submodules

+
+
+

com.vmware.vcenter.confidential_computing.sgx_client module

+

The com.vmware.vcenter.confidential_computing.sgx_client module covers VC +functionality to work with Intel CPUs Software Guard Extensions (SGX) on the +hosts.

+

Software Guard Extensions (SGX) is a feature of recent Intel CPUs that allows +users applications to create secure regions of memory-called enclaves-inside +their address space. An enclave is opaque to all software running outside of +the enclave, including the operating system and the hypervisor. In addition to +this isolation functionality, Intel SGX also provides remote attestation +capabilities, allowing external entities to verify that a specific SGX enclave +is running on a host. An enclave’s attestation quote is rooted on an +Intel-issued Platform Certification Key (PCK) certificate that binds the +current platform’s SGX cryptographic identity to Intel, essentially certifying +that it is a valid Intel SGX platform.

+
+
+class com.vmware.vcenter.confidential_computing.sgx_client.Hosts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Hosts classes provides methods to register Intel Software Guard +Extensions (SGX) for the hosts. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class RegisterSpec(host_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Hosts.RegisterSpec class contains the data necessary to identify +the host. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

host_id (str) – The host’s identifier. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem.

+
+
+
+ +
+
+register_task(spec)
+

Register host by stored SGX configuration. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

spec (Hosts.RegisterSpec) – Described the host that need to be registered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +for any other error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the host ID is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if register for same host is already in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the system does not support SGX Registration.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.confidential_computing.sgx_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.consumption_domains.html b/vsphere/8.0.2.0/com.vmware.vcenter.consumption_domains.html new file mode 100644 index 00000000..2db54d19 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.consumption_domains.html @@ -0,0 +1,320 @@ + + + + + + + com.vmware.vcenter.consumption_domains package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.consumption_domains package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.consumption_domains.zone_associations_client module

+
+
+class com.vmware.vcenter.consumption_domains.zone_associations_client.Cluster(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The CLUSTER class provides methods to query zone-cluster associations. +This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(clusters=None, zones=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.FilterSpec class contains attributes used to filter the +results when listing associations between clusters and zones, see +Cluster.list(). If multiple filtering criteria are provided in a +Cluster.FilterSpec, then the filtering is done based on all of them, +i.e., every returned zone-cluster association must satisfy all the +filtering criteria. This Cluster.FilterSpec class can be used to list +zones associated with a given cluster as well as to list the clusters +associated with a given zone. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • clusters (set of str or None) – Zone-cluster associations will be filtered such that each +association that is returned will have a cluster identifier from +this set of specified cluster identifiers. This attribute was added +in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None or empty, zone-cluster associations will not be filtered +based on cluster identifiers. Associations with any cluster +identifier will match this filter.

    • +

  • zones (set of str or None) – Zone-cluster associations will be filtered such that each +association that is returned will have a zone identifier from this +set of specified zone identifiers. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. +If None or empty, zone-cluster associations will not be filtered +based on zone identifiers. Associations with any zone identifier +will match this filter.

    • +
+
+
+
+ +
+
+class ListItem(zone=None, cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.ListItem class describes a zone-cluster association. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str) – Identifier of the zone. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • cluster (str) – Identifier of the cluster. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +
+
+
+
+ +
+
+class ListResult(associations=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.ListResult class contains the list of zone-cluster +associations. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

associations (list of Cluster.ListItem) – The list of zone-cluster associations. This attribute was added in +vSphere API 8.0.0.1.

+
+
+
+ +
+
+list(filter=None)
+

Returns zone-cluster associations that match the specified filter. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

filter (Cluster.FilterSpec or None) – The specification of matching zone-cluster associations. +If None, the behavior is equivalent to a +Cluster.FilterSpec with all attributes None, which means +all the zone-cluster associations will be returned.

+
+
Return type
+

Cluster.ListResult

+
+
Returns
+

Zone-cluster associations matching the Cluster.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zones in Cluster.FilterSpec +requires System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.consumption_domains.zone_associations_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.consumption_domains.zones.html b/vsphere/8.0.2.0/com.vmware.vcenter.consumption_domains.zones.html new file mode 100644 index 00000000..0c6a01f6 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.consumption_domains.zones.html @@ -0,0 +1,388 @@ + + + + + + + com.vmware.vcenter.consumption_domains.zones package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.consumption_domains.zones package

+
+

Submodules

+
+
+

com.vmware.vcenter.consumption_domains.zones.cluster_client module

+
+
+class com.vmware.vcenter.consumption_domains.zones.cluster_client.Associations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Associations class provides methods to manage associations of a +single consumption-domain zone to multiple vSphere clusters. This class was +added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Status(success=None, failed_clusters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Associations.Status class contains information about the outcome of +the method to add a set of vSphere clusters to a zone or the method to +remove a set of vSphere clusters from a zone. It also contains information +about the partial failures, in case the addition/removal failed for a +subset of clusters. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • success (bool) – This is true if the complete method succeeded without any errors. +Otherwise, it is false if all or some methods have failed. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • failed_clusters (dict of str and Exception) – Associations between the identifiers of the clusters for which the +operation failed and the reason of the failure. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: ClusterComputeResource. When methods return a value of +this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +ClusterComputeResource.

    • +
+
+
+
+ +
+
+add(zone, clusters)
+

Maps a consumption-domain zone to the specified vSphere clusters. If a +cluster or a subset of specified clusters are already members of the +specified zone, the result is success for those clusters. This method +supports partial success, i.e., it is possible that a subset of the +specified clusters get successfully associated with the specified zone +but the association fails for a subset of clusters. The returned result +will contain the details about only those clusters for which the +association failed. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • zone (str) – Identifier of the zone to be mapped to the specified vSphere +clusters. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • clusters (set of str) – Set of identifiers of vSphere clusters to which the the specified +zone should be mapped. +The parameter must contain identifiers for the resource type: +ClusterComputeResource.

    • +
+
+
Return type
+

Associations.Status

+
+
Returns
+

Status see . If the method failed, returns the reason of failures. +There will be an error message indicating the identifier of the +cluster for which the association failed and the reason of failure. +The cluster identifiers that are not present in will have been +successfully associated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if more than one cluster or an empty set of clusters is specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified zone is not known to this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires Zones.Manage privilege. - +Each resource of ClusterComputeResource referenced by the parameter +clusters requires Zone.ObjectAttachable privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires Zone.Manage.

    • +
+
+
+
+ +
+
+get(zone)
+

Returns identifiers of the clusters that are mapped to the specified +consumption-domain zone. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

zone (str) – Identifier of the zone to be queried for its associated vSphere +clusters. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

+
+
Return type
+

set of str

+
+
Returns
+

The set of vSphere clusters mapped to the specified zone. +The return value will contain identifiers for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified zone is not known to this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires System.Read.

    • +
+
+
+
+ +
+
+remove(zone, clusters)
+

Removes the mapping between the specified consumption-domain zone and +vSphere clusters. If a cluster or a subset of specified clusters are +not members of the specified zone, then the result is a success for +those clusters. In order to remove the mapping between a zone and a +cluster, there must not be any workload running in that zone because +removing the mapping between a zone and a cluster could result in +undefined behavior for the entities depending on this mapping to be +present. This method supports partial success, i.e., it is possible +that the mapping gets successfully removed for a subset of the clusters +but fails for another subset of the clusters. The returned result will +contain the details about only those clusters for which the method +failed. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • zone (str) – Identifier of the zone for which the mapping needs to be removed. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • clusters (set of str) – Set of identifiers of vSphere clusters which need to be removed +from the mapping. +The parameter must contain identifiers for the resource type: +ClusterComputeResource.

    • +
+
+
Return type
+

Associations.Status

+
+
Returns
+

Status see . If the method failed, returns the reason of failures. +There will be an error message indicating the identifier of the +cluster for which the association removal failed and the reason of +failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified zone is not known to this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if there is a workload running in the specified zone and depends on +this zone’s cluster associations to be present.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires Zones.Manage privilege. - +Each resource of ClusterComputeResource referenced by the parameter +clusters requires Zone.ObjectAttachable privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires Zone.Manage.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.consumption_domains.zones.cluster_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.content.html b/vsphere/8.0.2.0/com.vmware.vcenter.content.html new file mode 100644 index 00000000..787c574f --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.content.html @@ -0,0 +1,797 @@ + + + + + + + com.vmware.vcenter.content package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.content package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.content.registries_client module

+

The com.vmware.vcenter.content.registries_client module provides classes +and classes for managing image registries in vCenter.

+
+
+class com.vmware.vcenter.content.registries_client.DayOfWeek(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DayOfWeek class describes the supported days of the week to run a +specific operation for a container registry.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DayOfWeek instance.

+
+
+
+
+FRIDAY = DayOfWeek(string='FRIDAY')
+

Friday.

+
+ +
+
+MONDAY = DayOfWeek(string='MONDAY')
+

Monday.

+
+ +
+
+SATURDAY = DayOfWeek(string='SATURDAY')
+

Saturday.

+
+ +
+
+SUNDAY = DayOfWeek(string='SUNDAY')
+

Sunday.

+
+ +
+
+THURSDAY = DayOfWeek(string='THURSDAY')
+

Thursday.

+
+ +
+
+TUESDAY = DayOfWeek(string='TUESDAY')
+

Tuesday.

+
+ +
+
+WEDNESDAY = DayOfWeek(string='WEDNESDAY')
+

Wednesday.

+
+ +
+ +
+
+class com.vmware.vcenter.content.registries_client.Harbor(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Harbor class provides methods to manage the lifecycle of an +integrated Harbor container registry in vCenter.

+
+

Deprecated since version vSphere: API 8.0.1.00200 +Use com.vmware.vcenter.namespace_management.SupervisorServices and +com.vmware.vcenter.namespace_management.supervisor_services.ClusterSupervisorServices +instead to register and install a Harbor +service. See the Harbor supervisor service document for more details.

+
+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(cluster=None, garbage_collection=None, storage=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Harbor.CreateSpec class contains the specification required to +create a Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str or None) – Identifier of the cluster hosting the registry. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If None, registry will not be created on a specified cluster. This +is required in current version, since Harbor can only be created on +a cluster with Kubernetes enabled.

    • +

  • garbage_collection (Harbor.GarbageCollection or None) – Garbage collection configuration for the Harbor registry. +If None, a default configuration is set, Recurrence#WEEKLY, +DayOfWeek#SATURDAY, GarbageCollection#hour is 2, +GarbageCollection#minute is 0.

    • +

  • storage (list of Harbor.StorageSpec) – Storage associated with the Harbor registry. The list contains only +one storage backing in this version.

    • +
+
+
+
+ +
+
+class GarbageCollection(type=None, day_of_week=None, hour=None, minute=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Harbor.GarbageCollection class contains garbage collection +configuration for the Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Recurrence) – Frequency of garbage collection.

    • +

  • day_of_week (DayOfWeek) – Day of the week when garbage collection should run. +This attribute is optional and it is only relevant when the value +of type is Recurrence.WEEKLY.

    • +

  • hour (long) – Hour at which garbage collection should run. +This attribute is optional and it is only relevant when the value +of type is one of Recurrence.DAILY or +Recurrence.WEEKLY.

    • +

  • minute (long) – Minute at which garbage collection should run. +This attribute is optional and it is only relevant when the value +of type is one of Recurrence.DAILY or +Recurrence.WEEKLY.

    • +
+
+
+
+ +
+
+class Info(cluster=None, namespace=None, version=None, creation_time=None, ui_access_url=None, cert_chain=None, garbage_collection=None, storage=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Harbor.Info class contains detailed information about a running +Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str or None) – Identifier of the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If None, container registry is not created on the cluster specified +by Harbor.CreateSpec.cluster.

    • +

  • namespace (str or None) – Identifier of the Harbor namespace in case it is created in a +Kubernetes environment. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NamespaceInstance. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: NamespaceInstance. +If None, no Kubernetes namespace is created for the Harbor.

    • +

  • version (str) – Version of the registry.

    • +

  • creation_time (datetime.datetime) – The date and time when the harbor registry was created.

    • +

  • ui_access_url (str) – URL to access the UI of the registry.

    • +

  • cert_chain (list of str) – Harbor certificate chain in base64 format.

    • +

  • garbage_collection (Harbor.GarbageCollection) – Garbage collection information for the registry.

    • +

  • storage (list of Harbor.StorageInfo) – Storage information associated with the registry.

    • +

  • health (Health.Info) – Health status of the container registry.

    • +
+
+
+
+ +
+
+class StorageInfo(policy=None, capacity=None, used=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Harbor.StorageInfo class contains the detailed information about +storage used by the Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Identifier of the storage policy. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • capacity (long) – Total capacity for the registry storage (in mebibytes). This is the +storage limit set on the Harbor registry. If a storage limit was +not set on the registry, the default registry capacity - 204800 +mebibytes is used.

    • +

  • used (long) – Overall storage used by the registry (in mebibytes). This is the +sum of used storage associated with storage policies configured for +the registry.

    • +
+
+
+
+ +
+
+class StorageSpec(policy=None, limit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Harbor.StorageSpec class contains the specification required to +configure storage associated with a Harbor registry. In this version, +Harbor registry is created in Kubernetes environment, information in this +class will result in storage quotas on a Kubernetes namespace.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Identifier of the storage policy. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • limit (long or None) – The maximum amount of storage (in mebibytes) which can be utilized +by the registry for this specification. +If None, a default limit of 204800 mebibytes will be set as the +registry’s storage capacity.

    • +
+
+
+
+ +
+
+class Summary(cluster=None, registry=None, version=None, ui_access_url=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Harbor.Summary class contains basic information about a running +Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str or None) – Identifier of the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If None, container registry is not created on the cluster specified +by Harbor.CreateSpec.cluster.

    • +

  • registry (str) – Identifier of the registry. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.content.Registry. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.content.Registry.

    • +

  • version (str) – Version of the registry.

    • +

  • ui_access_url (str) – URL to access the UI of the registry.

    • +
+
+
+
+ +
+
+create(spec, client_token=None)
+

Creates a Harbor registry in the cluster.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+
    +

  • client_token (str or None) – A unique token generated on the client for each creation request. +The token should be a universally unique identifier (UUID), for +example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can +be used to guarantee idempotent creation. +If not specified, creation is not idempotent.

    • +

  • spec (Harbor.CreateSpec) – Specification for creating the Harbor registry.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the deployed registry. +The return value will be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a Harbor already exists in the associated cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if resources/objects could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if Harbor.CreateSpec.cluster does not have vSphere +namespace enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have ContentLibrary.ManageRegistry and/or +CertificateAuthority.Manage privilege, or user does not have +ContentLibrary.ManageClusterRegistryResource privilege on +Harbor.CreateSpec.cluster.

+
+
+
+ +
+
+delete(registry)
+

Delete the Harbor registry in the cluster. All Harbor projects, +repositories and images will be deleted upon Harbor registry deletion.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+

registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a registry specified by registry could not be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have ContentLibrary.ManageRegistry privilege.

+
+
+
+ +
+
+get(registry)
+

Get detailed information of the Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+

registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

+
+
Return type
+

Harbor.Info

+
+
Returns
+

Information about the registry.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a Harbor registry specified by registry could not be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list()
+

Returns basic information of all Harbor registries.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Return type
+

list of Harbor.Summary

+
+
Returns
+

The list of basic information of all Harbor registries.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.content.registries_client.Health(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Health class provides methods to retrieve health status for a +container registry.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(status=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Health.Info class contains health information about a container +registry.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Health.Status class describes the status of the container registry.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+DELETING = Status(string='DELETING')
+

Container registry is being deleted.

+
+ +
+
+ERROR = Status(string='ERROR')
+

Container registry failed to start or stopped with fatal error.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

Container registry is running.

+
+ +
+
+STARTING = Status(string='STARTING')
+

Container registry is starting.

+
+ +
+
+WARNING = Status(string='WARNING')
+

Container registry is running with some warning, for example, storage +reaches the threshold configuration.

+
+ +
+ +
+
+get(registry)
+

Returns the health information of a container registry in the vCenter.

+
+
Parameters
+

registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

+
+
Return type
+

Health.Info

+
+
Returns
+

Health information of the registry.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the registry does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is not a member of the Administrators

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.content.registries_client.Recurrence(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Recurrence class defines the supported values for how often to run +a specific operation for a container registry.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Recurrence instance.

+
+
+
+
+DAILY = Recurrence(string='DAILY')
+

An operation occurs on a daily basis.

+
+ +
+
+NONE = Recurrence(string='NONE')
+

No operation is scheduled.

+
+ +
+
+WEEKLY = Recurrence(string='WEEKLY')
+

An operation occurs on a weekly basis.

+
+ +
+ +
+
+class com.vmware.vcenter.content.registries_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.content.registries.html b/vsphere/8.0.2.0/com.vmware.vcenter.content.registries.html new file mode 100644 index 00000000..f6bfb15c --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.content.registries.html @@ -0,0 +1,624 @@ + + + + + + + com.vmware.vcenter.content.registries package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.content.registries package

+
+

Submodules

+
+
+

com.vmware.vcenter.content.registries.harbor_client module

+

The com.vmware.vcenter.content.registries.harbor_client module provides +classes and classes for managing Harbor registry in vCenter.

+
+
+class com.vmware.vcenter.content.registries.harbor_client.Projects(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Projects class provides methods for managing the lifecycle of +Harbor project that stores and distributes container repositories and +images.

+
+

Deprecated since version vSphere: API 8.0.1.00200 +Since the parent resource +com.vmware.vcenter.content.registries.harbor_client is +deprecated.

+
+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfigStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Projects.ConfigStatus class describes the status of reaching the +desired configuration state for the Harbor project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigStatus instance.

+
+
+
+
+ERROR = ConfigStatus(string='ERROR')
+

Failed to create Harbor project or apply the configuration to the project, +user intervention needed.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+ +
+
+PENDING = ConfigStatus(string='PENDING')
+

Harbor project is being created or the configuration is being applied to +the project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+ +
+
+READY = ConfigStatus(string='READY')
+

Harbor project is created or configured correctly.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+ +
+
+REMOVING = ConfigStatus(string='REMOVING')
+

The configuration is being removed and Harbor project is being deleted.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+ +
+ +
+
+class CreateSpec(name=None, scope=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Projects.CreateSpec class defines the information required to +create a Harbor project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the Harbor project. Should be between 1-63 characters long +alphanumeric string and may contain the following characters: +a-z,0-9, and ‘-’. Must be starting with characters or numbers, with +the ‘-’ character allowed anywhere except the first or last +character.

    • +

  • scope (Projects.Scope) – Access type of a Harbor project.

    • +
+
+
+
+ +
+
+class Info(name=None, config_status=None, scope=None, creation_time=None, update_time=None, access_url=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Projects.Info class contains detailed information about a Harbor +project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the Harbor project. Should be between 1-63 characters long +alphanumeric string and may contain the following characters: +a-z,0-9, and ‘-’. Must be starting with characters or numbers, with +the ‘-’ character allowed anywhere except the first or last +character.

    • +

  • config_status (Projects.ConfigStatus) – The status of the Harbor project.

    • +

  • scope (Projects.Scope) – The access type of a Harbor project.

    • +

  • creation_time (datetime.datetime) – The date and time when the harbor project creation API was +triggered and project identifier generated.

    • +

  • update_time (datetime.datetime) – The date and time when the harbor project purge API was triggered. +In case no purge was triggered, updateTime is same as +creationTime. +This attribute is optional and it is only relevant when the value +of configStatus is Projects.ConfigStatus.READY.

    • +

  • access_url (str) – URL to access the harbor project through docker client. +This attribute is optional and it is only relevant when the value +of configStatus is Projects.ConfigStatus.READY.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – Details about the ERROR project status. +This attribute is optional and it is only relevant when the value +of configStatus is Projects.ConfigStatus.ERROR.

    • +
+
+
+
+ +
+
+class Scope(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Projects.Scope class in a project defines access levels of the +project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Scope instance.

+
+
+
+
+PRIVATE = Scope(string='PRIVATE')
+

A Harbor project can only be accessed by assigned users.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+ +
+
+PUBLIC = Scope(string='PUBLIC')
+

A Harbor project can be accessed by everyone.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+ +
+ +
+
+class Summary(project=None, name=None, scope=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Projects.Summary class contains basic information about a Harbor +project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • project (str) – Identifier of the harbor project. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.Harbor.Project. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.content.Registry.Harbor.Project.

    • +

  • name (str) – Name of the Harbor project. Should be between 1-63 characters long +alphanumeric string and may contain the following characters: +a-z,0-9, and ‘-’. Must be starting with characters or numbers, with +the ‘-’ character allowed anywhere except the first or last +character.

    • +

  • scope (Projects.Scope) – Access type of a Harbor project.

    • +
+
+
+
+ +
+
+create(registry, spec)
+

Creates a project in a Harbor registry using the supplied +specification. In vSphere 7.0, a Harbor registry is deployed in a +vSphere cluster with vSphere namespaces enabled. When a namespace is +created, a project with same name as the namespace is created in the +Harbor registry, so this method should not be called.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+
    +

  • registry (str) – Identifier of the Registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

    • +

  • spec (Projects.CreateSpec) – Information used to create the Harbor project.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly created Harbor project. +The return value will be an identifier for the resource type: +com.vmware.vcenter.content.Registry.Harbor.Project.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if Harbor registry is being deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a registry specified by registry could not be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a project with the same name already exists in the registry. In +vSphere 7.0, the existing project could have been created +automatically when a namespace with the same name is created.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have ContentLibrary.ManageRegistryProject +privilege.

+
+
+
+ +
+
+delete(registry, project)
+

Deletes the specified project from Harbor registry. Repositories and +images in the project will be removed upon project deletion. Storage +space of deleted images in the project will be reclaimed through next +scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor +registry is deployed in a vSphere cluster with vSphere namespaces +enabled. When a namespace is deleted, a project with same name as the +namespace is deleted from the Harbor registry, so this method should +not be called.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+
    +

  • registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

    • +

  • project (str) – Identifier of the Harbor project. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.Harbor.Project.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if Harbor registry is being deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if registry or project cannot be found. In vSphere 7.0, the +existing project could have been deleted automatically when a +namespace with the same name is deleted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have ContentLibrary.ManageRegistryProject +privilege.

+
+
+
+ +
+
+get(registry, project)
+

Returns detailed information about the specified Harbor project.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+
    +

  • registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

    • +

  • project (str) – Identifier of the Harbor project. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.Harbor.Project.

    • +
+
+
Return type
+

Projects.Info

+
+
Returns
+

Detailed information about the specified Harbor project.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if registry or project cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list(registry)
+

Returns basic information of all projects in a Harbor registry.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+

registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

+
+
Return type
+

list of Projects.Summary

+
+
Returns
+

The list of summary information of all Harbor projects.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if registry cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+purge(registry, project)
+

Remove all repositories, images and members in the project. Storage +space of deleted images in the project will be reclaimed through next +scheduled Harbor registry garbage collection.

+
+

Deprecated since version vSphere: API 8.0.1.00200

+
+
+
Parameters
+
    +

  • registry (str) – Identifier of the registry. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.

    • +

  • project (str) – Identifier of the Harbor project. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.content.Registry.Harbor.Project.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if registry or project cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if Harbor registry is being deleted or the project is not in +Projects.ConfigStatus.READY status.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have ContentLibrary.ManageRegistryProject +privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.content.registries.harbor_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.crypto_manager.hosts.html b/vsphere/8.0.2.0/com.vmware.vcenter.crypto_manager.hosts.html new file mode 100644 index 00000000..e178cb84 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.crypto_manager.hosts.html @@ -0,0 +1,471 @@ + + + + + + + com.vmware.vcenter.crypto_manager.hosts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.crypto_manager.hosts package

+
+

Submodules

+
+
+

com.vmware.vcenter.crypto_manager.hosts.kms_client module

+

The com.vmware.vcenter.crypto_manager.hosts.kms_client module provides +classes for managing key providers.

+
+
+class com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Providers class provides methods to retrieve providers on a host. +This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(providers=None, health=None, types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.FilterSpec class contains attributes used to filter the +results when listing providers. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • providers (set of str or None) – Provider identifiers. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. +If None or empty, the result will not be filtered by provider +identifier.

    • +

  • health (set of Providers.Health or None) – Provider health status. This attribute was added in vSphere API +7.0.2.0. +If None or empty, the result will not be filtered by provider +health status.

    • +

  • types (set of Providers.Type or None) – Provider types. This attribute was added in vSphere API 7.0.2.0. +If None or empty, the result will not be filtered by provider type.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.Health class contains the health status of a provider. +This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

There is a critical issue that requires attention. This class attribute was +added in vSphere API 7.0.2.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No health status is available. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+OK = Health(string='OK')
+

Operating normally. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Operating normally, but there is an issue that requires attention. This +class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class Info(health=None, details=None, type=None, native_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Info class contains attributes that describe the details +of a provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class NativeProviderInfo(key_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.NativeProviderInfo class contains attributes that +describe details of a native provider. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

key_id (str) – Key identifier for the provider. This attribute was added in +vSphere API 7.0.2.0.

+
+
+
+ +
+
+class Summary(provider=None, type=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Summary class contains attributes that describe a +provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – Identifier of the provider. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    • +

  • type (Providers.Type) – Provider type. This attribute was added in vSphere API 7.0.2.0.

    • +

  • health (Providers.Health) – Health status of the provider. This attribute was added in vSphere +API 7.0.2.0.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.Type class contains the types of providers. This +enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+NATIVE = Type(string='NATIVE')
+

Native provider. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+TRUST_AUTHORITY = Type(string='TRUST_AUTHORITY')
+

Trust Authority provider. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+ +
+
+get(host, provider)
+

Get a provider on a host. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • host (str) – Host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • provider (str) – Provider identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    • +
+
+
Return type
+

Providers.Info

+
+
Returns
+

Information of the provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the host identifier is empty or the provider identifier is +empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the provider or the host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Cryptographer.ReadKeyServersInfo.

    • +
+
+
+
+ +
+
+list(host, filter_spec=None)
+

List the available providers on a host. This method was added in +vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • host (str) – Host identifier. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • filter_spec (Providers.FilterSpec or None) – Filter spec. +If None, the behavior is equivalent to a +Providers.FilterSpec with all attributes None.

    • +
+
+
Return type
+

list of Providers.Summary

+
+
Returns
+

Summary of providers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the host identifier is empty or the FilterSpec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Cryptographer.ReadKeyServersInfo.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.crypto_manager.hosts.kms_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.crypto_manager.html b/vsphere/8.0.2.0/com.vmware.vcenter.crypto_manager.html new file mode 100644 index 00000000..6a7c3539 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.crypto_manager.html @@ -0,0 +1,1081 @@ + + + + + + + com.vmware.vcenter.crypto_manager package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.crypto_manager package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.crypto_manager.hosts_client module

+

The com.vmware.vcenter.crypto_manager.hosts_client module provides classes +for managing key providers and cryptographic keys on hosts.

+
+
+class com.vmware.vcenter.crypto_manager.hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.crypto_manager.kms_client module

+

The com.vmware.vcenter.crypto_manager.kms_client module provides classes +for managing key providers and cryptographic keys.

+
+
+class com.vmware.vcenter.crypto_manager.kms_client.Providers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Providers class provides methods to create, retrieve, update, +delete, export and import providers. This class was added in vSphere API +7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Constraints(tpm_required=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Constraints class contains constraints on a provider. +This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

tpm_required (bool) – Determines if a provider is restricted to hosts with TPM 2.0 +capability. This attribute was added in vSphere API 7.0.2.0.

+
+
+
+ +
+
+class ConstraintsSpec(tpm_required=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ConstraintsSpec class contains constraints to be imposed +on a provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

tpm_required (bool or None) – Determines if a provider is restricted to hosts with TPM 2.0 +capability. This attribute was added in vSphere API 7.0.2.0. +If None, the constraint does not apply to the provider.

+
+
+
+ +
+
+class CreateSpec(provider=None, constraints=None, native_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.CreateSpec class contains attributes that describe the +desired configuration for a new provider. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) –

    Provider identifier.

    +

    A unique string provided by the client.. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    +

    • +

  • constraints (Providers.ConstraintsSpec or None) – The constraints on the provider. This attribute was added in +vSphere API 7.0.2.0. +If None there are no constraints on the provider.

    • +

  • native_spec (Providers.NativeProviderCreateSpec or None) – Native provider create spec. This attribute was added in vSphere +API 7.0.2.0. +This attribute is required when creating a +Providers.Type.NATIVE provider.

    • +
+
+
+
+ +
+
+class ExportResult(type=None, location=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ExportResult class contains result of +Providers.export() operation. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Providers.ExportType) – Type of provider export result. This attribute was added in vSphere +API 7.0.2.0.

    • +

  • location (Providers.Location) – Location of the exported configuration. This attribute was added in +vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of type is Providers.ExportType.LOCATION.

    • +
+
+
+
+ +
+
+class ExportSpec(provider=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ExportSpec class contains attributes that are needed to +export a provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – Provider identifier. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    • +

  • password (str or None) – Password used to encrypt the exported configuration. This attribute +was added in vSphere API 7.0.2.0. +If None or empty, the configuration will not be encrypted.

    • +
+
+
+
+ +
+
+class ExportType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.ExportType class identifies the type of result that is +returned when a provider is exported. This enumeration was added in vSphere +API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ExportType instance.

+
+
+
+
+LOCATION = ExportType(string='LOCATION')
+

Result returned as a URL from which the provider configuration can be +downloaded. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class FilterSpec(providers=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.FilterSpec class contains attributes used to filter the +results when listing providers. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • providers (set of str or None) – Provider identifiers. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. +If None or empty, the result will not be filtered by provider +identifier.

    • +

  • health (set of Providers.Health or None) – Provider health status. This attribute was added in vSphere API +7.0.2.0. +If None or empty, the result will not be filtered by provider +health status.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.Health class describes the health status of a provider. +This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

There is a critical issue that requires attention. This class attribute was +added in vSphere API 7.0.2.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No health status is available. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+OK = Health(string='OK')
+

Operating normally. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Operating normally, but there is an issue that requires attention. This +class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class ImportResult(provider=None, type=None, native_info=None, export_time=None, constraints=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ImportResult class contains result of the +Providers.import_provider() operation. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – Provider identifier. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    • +

  • type (Providers.Type) – Provider type. This attribute was added in vSphere API 7.0.2.0.

    • +

  • native_info (Providers.NativeProviderInfo) – Native provider information. This attribute was added in vSphere +API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of type is Providers.Type.NATIVE.

    • +

  • export_time (datetime.datetime) – Time when the provider was exported. This attribute was added in +vSphere API 7.0.2.0.

    • +

  • constraints (Providers.Constraints or None) – The constraints on the provider. This attribute was added in +vSphere API 7.0.2.0. +If None, there are no constraints on the provider.

    • +
+
+
+
+ +
+
+class ImportSpec(config=None, password=None, constraints=None, dry_run=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ImportSpec class contains attributes that are needed to +import a provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config (str or None) – Configuration to import. This attribute was added in vSphere API +7.0.2.0. +Currently this is required. Other import methods may be supported +in the future.

    • +

  • password (str or None) – Password to decrypt the configuration to import. This attribute was +added in vSphere API 7.0.2.0. +If None or empty, configuration to import must be unencrypted.

    • +

  • constraints (Providers.ConstraintsSpec or None) – Constraints to impose on the imported provider. This attribute was +added in vSphere API 7.0.2.0. +If None, the imported provider constraints will match the exported +provider constraints.

    • +

  • dry_run (bool or None) – Whether to perform a trial import without actuallly creating a +provider. This attribute was added in vSphere API 7.0.2.0. +If None, a new provider will be created.

    • +
+
+
+
+ +
+
+class Info(health=None, details=None, constraints=None, type=None, native_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Info class contains attributes that describe the details +of a provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (Providers.Health) – Health status of the provider. This attribute was added in vSphere +API 7.0.2.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health status of the provider.

    +

    When the provider Providers.Health is not +Providers.Health.NONE or Providers.Health.OK, this +attribute will provide actionable descriptions of the issues.. This +attribute was added in vSphere API 7.0.2.0.

    +

    • +

  • constraints (Providers.Constraints or None) – The constraints on the provider. This attribute was added in +vSphere API 7.0.2.0. +If None, there are no constraints on the provider.

    • +

  • type (Providers.Type) – Provider type. This attribute was added in vSphere API 7.0.2.0.

    • +

  • native_info (Providers.NativeProviderInfo) – Native provider information. This attribute was added in vSphere +API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of type is Providers.Type.NATIVE.

    • +
+
+
+
+ +
+
+class Location(url=None, download_token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Location class contains the location as well as a token +required (as a header in the HTTP GET request) to download the +configuration. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • url (str) – Provider configuration download URL. This attribute was added in +vSphere API 7.0.2.0.

    • +

  • download_token (Providers.Token) – Information about the token required in the HTTP GET request to +download the provider configuration. This attribute was added in +vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class NativeProviderCreateSpec(key_id=None, key_derivation_key=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.NativeProviderCreateSpec class contains attributes that +describe the desired configuration for a Providers.Type.NATIVE +provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key_id (str or None) –

    Key identifier for the provider.

    +

    The key identifier is required to be a 128-bit UUID represented as +a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc” +format.. This attribute was added in vSphere API 7.0.2.0. +If None, the key identifier will be generated automatically.

    +

    • +

  • key_derivation_key (str or None) – Key used to derive data encryption keys. Base64 encoded. This +attribute was added in vSphere API 7.0.2.0. +If None, the key derivation key will be generated automatically.

    • +
+
+
+
+ +
+
+class NativeProviderInfo(key_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.NativeProviderInfo class contains attributes that +describe details of a native provider. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

key_id (str) – Key identifier for the provider. This attribute was added in +vSphere API 7.0.2.0.

+
+
+
+ +
+
+class NativeProviderUpdateSpec(key_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.NativeProviderUpdateSpec class contains attributes that +describe the desired configuration for Providers.Type.NATIVE +provider. Exporting a Providers.Type.NATIVE provider to create a +new back-up is suggested after any update. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

key_id (str or None) –

Key identifier for the provider.

+

The key identifier is required to be a 128-bit UUID represented as +a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc” +format.. This attribute was added in vSphere API 7.0.2.0. +If None, the key identifier will remain unchanged.

+

+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.crypto_manager.kms.provider'
+

Resource type for a provider. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+
+class Summary(provider=None, type=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Summary class contains attributes that describe a +provider. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – Provider identifier. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    • +

  • type (Providers.Type) – Provider type. This attribute was added in vSphere API 7.0.2.0.

    • +

  • health (Providers.Health) – Health status of the provider. This attribute was added in vSphere +API 7.0.2.0.

    • +
+
+
+
+ +
+
+class Token(token=None, expiry=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Token class contains information about the token required +to be passed in the HTTP header in the HTTP GET request to download the +provider configuration. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • token (str) –

    A one-time, short-lived token required in “Authorization” field of +the HTTP header of the request to the url.

    +

    After the token expires, any attempt to download the configuration +with said token will fail.. This attribute was added in vSphere API +7.0.2.0.

    +

    • +

  • expiry (datetime.datetime) – Expiry time of the token. This attribute was added in vSphere API +7.0.2.0.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.Type class contains the types of providers. This +enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+NATIVE = Type(string='NATIVE')
+

Native provider. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class UpdateSpec(native_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.UpdateSpec class contains attributes that describe the +new configuration for an existing provider. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

native_spec (Providers.NativeProviderUpdateSpec or None) –

New Configuration for Providers.Type.NATIVE provider.

+

. This attribute was added in vSphere API 7.0.2.0. +If None, provider configuration will remain unchanged.

+

+
+
+
+ +
+
+create(spec)
+

Add a new provider. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+

spec (Providers.CreateSpec) – Provider information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a provider with the same identifier already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if creating a provider of the type is not supported.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ManageKeyServers.

    • +
+
+
+
+ +
+
+delete(provider)
+

Remove a provider. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+

provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the provider identifier is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the provider’s type does not allow deletion.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ManageKeyServers.

    • +
+
+
+
+ +
+
+export(spec)
+

Export provider configuration. This method was added in vSphere API +7.0.2.0.

+
+
Parameters
+

spec (Providers.ExportSpec) – ExportSpec needed to export a provider.

+
+
Return type
+

Providers.ExportResult

+
+
Returns
+

ExportResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the provider identifier is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the provider with the identifier is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the provider’s type does not allow export.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ManageKeyServers.

    • +
+
+
+
+ +
+
+get(provider)
+

Return information about a provider. This method was added in vSphere +API 7.0.2.0.

+
+
Parameters
+

provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

+
+
Return type
+

Providers.Info

+
+
Returns
+

Information of the provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the provider identifier is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ReadKeyServersInfo.

    • +
+
+
+
+ +
+
+import_provider(spec)
+

Import provider configuration. This method was added in vSphere API +7.0.2.0.

+
+
Parameters
+

spec (Providers.ImportSpec) – ImportSpec needed to import a provider.

+
+
Return type
+

Providers.ImportResult

+
+
Returns
+

importResult ImportResult.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a provider with the same identifier already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the config or the password is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ManageKeyServers.

    • +
+
+
+
+ +
+
+list(filter_spec=None)
+

Return a list of providers.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+

filter_spec (Providers.FilterSpec or None) – Filter for the providers list. +If None, the behavior is equivalent to a +Providers.FilterSpec with all attributes None.

+
+
Return type
+

list of Providers.Summary

+
+
Returns
+

Summary of providers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ReadKeyServersInfo.

    • +
+
+
+
+ +
+
+update(provider, spec)
+

Update an existing provider. This method was added in vSphere API +7.0.2.0.

+
+
Parameters
+
    +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.crypto_manager.kms.provider.

    • +

  • spec (Providers.UpdateSpec) – Provider information.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the provider’s type does not allow updates.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Cryptographer.ManageKeyServers.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.crypto_manager.kms_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.deployment.html b/vsphere/8.0.2.0/com.vmware.vcenter.deployment.html new file mode 100644 index 00000000..5dd5fd49 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.deployment.html @@ -0,0 +1,341 @@ + + + + + + + com.vmware.vcenter.deployment package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.deployment package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.deployment.install_client module

+
+
+class com.vmware.vcenter.deployment.install_client.RemotePsc(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The RemotePsc class provides methods to check if the deployed vCenter +Server can register with the remote PSC. This class was added in vSphere +API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+check(spec)
+

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.

+
+
Parameters
+

spec (com.vmware.vcenter.deployment_client.RemotePscSpec) – Information to connect to the remote PSC.

+
+
Return type
+

com.vmware.vcenter.deployment_client.CheckInfo

+
+
Returns
+

Information about the success or failure of the checks that were +performed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if external PSC credentials are not valid when configuring a +VCSA_EXTERNAL appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment.install_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.deployment.migrate_client module

+
+
+class com.vmware.vcenter.deployment.migrate_client.ActiveDirectory(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ActiveDirectory class provides methods to check if the migrated +vCenter Server appliance can join to the given domain using the provided +credentials. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckSpec(dns_servers=None, domain=None, username=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ActiveDirectory.CheckSpec class contains information used to join +the migrated vCenter Server appliance to the Active Directory. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dns_servers (list of str) – IP addresses of the DNS servers of the Active Directory server. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • domain (str) – The domain name of the Active Directory server to which the +migrated vCenter Server appliance should be joined. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • username (str) – Active Directory user that has permission to join the Active +Directory after the vCenter Server is migrated to appliance. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • password (str) – Active Directory user password that has permission to join the +Active Directory after the vCenter Server is migrated to appliance. +This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+check(spec)
+

Checks whether the provided Active Directory user has permission to +join the migrated vCenter Server appliance to the domain. This method +was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (ActiveDirectory.CheckSpec) – Information to connect to Active Directory.

+
+
Return type
+

com.vmware.vcenter.deployment_client.CheckInfo

+
+
Returns
+

Information about the success or failure of the checks that were +performed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec(domain=None, username=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ActiveDirectorySpec class contains information used to join the +migrated vCenter Server appliance to the Active Directory. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • domain (str) – The domain name of the Active Directory server to which the +migrated vCenter Server appliance should be joined. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • username (str) – Active Directory user that has permission to join the Active +Directory after the vCenter Server is migrated to appliance. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • password (str) – Active Directory user password that has permission to join the +Active Directory after the vCenter Server is migrated to appliance. +This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment.migrate_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.deployment.install.html b/vsphere/8.0.2.0/com.vmware.vcenter.deployment.install.html new file mode 100644 index 00000000..c65443ac --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.deployment.install.html @@ -0,0 +1,257 @@ + + + + + + + com.vmware.vcenter.deployment.install package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.deployment.install package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.deployment.install.psc_client module

+
+
+class com.vmware.vcenter.deployment.install.psc_client.Replicated(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Replicated class provides methods to check if the configuring +vCenter Server can be replicated to the remote PSC. This class was added in +vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+check(spec)
+

Checks whether the provided remote PSC is reachable and can be +replicated. This method was added in vSphere API 6.7.

+
+
Parameters
+

spec (com.vmware.vcenter.deployment_client.ReplicatedPscSpec) – Information to configure a replicated PSC.

+
+
Return type
+

com.vmware.vcenter.deployment_client.CheckInfo

+
+
Returns
+

Information about the success or failure of the checks that were +performed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if external PSC credentials are not valid when configuring PSC to +replicate with an external existing PSC.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment.install.psc_client.Standalone(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Standalone class provides methods to check if the values provided +for the standalone PSC satisfies the requirements. This class was added in +vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+check(spec)
+

Checks that the information to configure a non-replicated PSC satisfies +the requirements. This method was added in vSphere API 6.7.

+
+
Parameters
+

spec (com.vmware.vcenter.deployment_client.StandalonePscSpec) – Information to configure a non-replicated PSC.

+
+
Return type
+

com.vmware.vcenter.deployment_client.CheckInfo

+
+
Returns
+

Information about the success or failure of the checks that were +performed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment.install.psc_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.deployment.install.initial_config.html b/vsphere/8.0.2.0/com.vmware.vcenter.deployment.install.initial_config.html new file mode 100644 index 00000000..b7859334 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.deployment.install.initial_config.html @@ -0,0 +1,214 @@ + + + + + + + com.vmware.vcenter.deployment.install.initial_config package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.deployment.install.initial_config package

+
+

Submodules

+
+
+

com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module

+
+
+class com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Thumbprint class provides methods to get the thumbprint of the +remote PSC. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class RemoteSpec(address=None, https_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Thumbprint.RemoteSpec class contains the information used to +connect to the remote PSC. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – The IP address or DNS resolvable name of the remote PSC. This +attribute was added in vSphere API 6.7.

    • +

  • https_port (long or None) – The HTTPS port of the remote PSC. This attribute was added in +vSphere API 6.7. +If None, port 443 will be used.

    • +
+
+
+
+ +
+
+get(spec)
+

Gets the SHA1 thumbprint of the remote PSC. This method was added in +vSphere API 6.7.

+
+
Parameters
+

spec (Thumbprint.RemoteSpec) – Information used to connect to the remote PSC.

+
+
Return type
+

str

+
+
Returns
+

The thumbprint of the specified remote PSC

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +on exception.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.host.html b/vsphere/8.0.2.0/com.vmware.vcenter.host.html new file mode 100644 index 00000000..1b83fa39 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.host.html @@ -0,0 +1,403 @@ + + + + + + + com.vmware.vcenter.host package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.host package

+
+

Submodules

+
+
+

com.vmware.vcenter.host.entropy_client module

+

The com.vmware.vcenter.host.entropy_client module provides classes to +manage entropy

+
+
+class com.vmware.vcenter.host.entropy_client.ExternalPool(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ExternalPool class provides methods to send entropy data and query +external entropy pool information on an ESX host. Clients can check the +entropy level of an ESX host using the ExternalPool.get() method to +check . When the entropy level has dropped below a threshold, a client can +use the ExternalPool.add() method to add additional entropy until as +required. This class was added in vSphere API 8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class AddResult(capacity=None, currently_available=None, low_watermark=None, inactive_source_timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ExternalPool.AddResult class provides result of the +ExternalPool.add() method. This class was added in vSphere API +8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • capacity (long) – Capacity of external entropy pool in bytes. This attribute was +added in vSphere API 8.0.1.0.

    • +

  • currently_available (long) – Currently available amount of entropy in bytes in the external +entropy pool. This attribute was added in vSphere API 8.0.1.0.

    • +

  • low_watermark (long) – A threshold value in bytes. An audit record will be logged when +ExternalPool.AddResult.currently_available drops below this +value. This attribute was added in vSphere API 8.0.1.0.

    • +

  • inactive_source_timeout (long) –

    A timeout period in seconds within which the client must call +ExternalPool.get() method or ExternalPool.add() method. +If no call is received before the timeout lapses an audit record +will be created.

    +

    This is the timeout to detect any connection lost with the client.. +This attribute was added in vSphere API 8.0.1.0.

    +

    • +
+
+
+
+ +
+
+class AddSpec(data=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ExternalPool.AddSpec class defines parameters for the +ExternalPool.add() method. This class was added in vSphere API +8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

data (str) – Buffer for entropy data. This will carry entropy data received from +the external entropy source. This attribute was added in vSphere +API 8.0.1.0.

+
+
+
+ +
+
+class Info(status=None, capacity=None, currently_available=None, low_watermark=None, inactive_source_timeout=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ExternalPool.Info class contains entropy pool information on the +ESX host. It provides external entropy pool details as well as timeout in +seconds within which client has to keep calling ExternalPool.get() +method.

+

Client has to monitor Info.currentlyAvailable parameter. Before the entropy +level goes down below a threshold value the client has to send entropy data +by calling ExternalPool.add() method.. This class was added in +vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (ExternalPool.Status) – This flag indicates entropy service is enabled or not in a ESX +host. This attribute was added in vSphere API 8.0.1.0.

    • +

  • capacity (long) – Capacity of external entropy pool in bytes. This attribute was +added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is ExternalPool.Status.ENABLED.

    • +

  • currently_available (long) – Currently available amount of entropy in bytes in the external +entropy pool. This attribute was added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is ExternalPool.Status.ENABLED.

    • +

  • low_watermark (long) – A threshold value in bytes. An audit record will be logged when +ExternalPool.Info.currently_available drops below this +value. This attribute was added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is ExternalPool.Status.ENABLED.

    • +

  • inactive_source_timeout (long) –

    A timeout period in seconds within which the client must call +ExternalPool.get() method or ExternalPool.add() method. +If no call is received before the timeout lapses an audit record +will be created.

    +

    This timeout is used to detect that connection with the client is +lost.. This attribute was added in vSphere API 8.0.1.0. +This attribute is optional and it is only relevant when the value +of status is ExternalPool.Status.ENABLED.

    +

    • +
+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ExternalPool.Status enum represents external entropy status on an +ESX host. This enumeration was added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+DISABLED = Status(string='DISABLED')
+

External entropy is disabled for the ESX host. This class attribute was +added in vSphere API 8.0.1.0.

+
+ +
+
+ENABLED = Status(string='ENABLED')
+

External entropy is enabled for the ESX host. This class attribute was +added in vSphere API 8.0.1.0.

+
+ +
+ +
+
+add(host, spec)
+

Adds additional entropy to the pool. This API will accept maximum +(ExternalPool.Info.capacity - +ExternalPool.Info.currently_available) bytes of entropy. Extra +entropy data sent will be discarded. This method was added in vSphere +API 8.0.1.0.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • spec (ExternalPool.AddSpec) – contains buffer of entropy data.

    • +
+
+
Return type
+

ExternalPool.AddResult

+
+
Returns
+

Result of add method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the host is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Entropy.Write.

    • +
+
+
+
+ +
+
+get(host)
+

Retrieves the entropy pool details of a host including current entropy +level. This method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

ExternalPool.Info

+
+
Returns
+

Entropy details of a host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the host is not available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Entropy.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.host.entropy_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.html b/vsphere/8.0.2.0/com.vmware.vcenter.html new file mode 100644 index 00000000..334ffdd6 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.html @@ -0,0 +1,28874 @@ + + + + + + + com.vmware.vcenter package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.authentication_client module

+

The com.vmware.vcenter.authentication_client module provides authentication +classes specific to the com.vmware.vcenter module. The +com.vmware.vcenter.authentication_client module is available starting in +vSphere 7.0 U2.

+
+
+class com.vmware.vcenter.authentication_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.authentication_client.Token(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Token interface provides operations for obtaining an access token.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class IssueSpec(grant_type=None, resource=None, audience=None, scope=None, requested_token_type=None, subject_token=None, subject_token_type=None, actor_token=None, actor_token_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Token.IssueSpec class contains arguments required for token +exchange.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • grant_type (str) – The value of urn:ietf:params:oauth:grant-type:token-exchange +indicates that a token exchange is being performed. +When clients pass a value of this class as a parameter, the +attribute must be one of +urn:ietf:params:oauth:grant-type:token-exchange. When methods +return a value of this class as a return value, the attribute will +be one of urn:ietf:params:oauth:grant-type:token-exchange.

    • +

  • resource (str or None) – Indicates the location of the target service or resource where the +client intends to use the requested security token. +If None, it is inferred from other arguments.

    • +

  • audience (str or None) – The logical name of the target service where the client intends to +use the requested security token. This serves a purpose similar to +the Token.IssueSpec.resource attribute, but with the client +providing a logical name rather than a location. +If None, it is inferred from other arguments.

    • +

  • scope (str or None) – A list of space-delimited, case-sensitive strings, that allow the +client to specify the desired scope of the requested security token +in the context of the service or resource where the token will be +used. +If None, it is inferred from other arguments.

    • +

  • requested_token_type (str or None) – An identifier for the type of the requested security token. If the +requested type is unspecified, the issued token type is at the +discretion of the server and may be dictated by knowledge of the +requirements of the service or resource indicated by the +Token.IssueSpec.resource or +Token.IssueSpec.audience attribute. +If None, it is inferred from other arguments.

    • +

  • subject_token (str or None) –

    A security token that represents the identity of the party on +behalf of whom exchange is being made. Typically, the subject of +this token will be the subject of the security token issued. Token +is base64-encoded.

    +

    The attribute is required when the value of the +Token.IssueSpec.grant_type attribute is +urn:ietf:params:oauth:grant-type:token-exchange. +This attribute is currently required. In the future, the class may +support grant-types other than +urn:ietf:params:oauth:grant-type:token-exchange for which the +value may be None.

    +

    • +

  • subject_token_type (str or None) –

    An identifier, that indicates the type of the security token in the +Token.IssueSpec.subject_token attribute.

    +

    The attribute is required when the value of the +Token.IssueSpec.grant_type attribute is +urn:ietf:params:oauth:grant-type:token-exchange. +This attribute is currently required. In the future, the class may +support grant-types other than +urn:ietf:params:oauth:grant-type:token-exchange for which the +value may be None.

    +

    • +

  • actor_token (str or None) – A security token that represents the identity of the acting party. +Typically, this will be the party that is authorized to use the +requested security token and act on behalf of the subject. +None if not needed for the specific case of exchange.

    • +

  • actor_token_type (str or None) – An identifier, that indicates the type of the security token in the +Token.IssueSpec.actor_token attribute. +None if Token.IssueSpec.actor_token attribute is not +present.

    • +
+
+
+
+ +
+
+issue(spec)
+

Provides a token endpoint as defined in RFC 6749.

+

Supported grant types:

+ +

This method supercedes +com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST +rendering of the newer operation matches RFC8693’s definition for both +input and output of the method.

+
+
Parameters
+

spec (Token.IssueSpec) – Token.IssueSpec class containing arguments that define the +exchange process.

+
+
Return type
+

com.vmware.oauth2_client.TokenInfo

+
+
Returns
+

com.vmware.oauth2_client.TokenInfo class that contains a +newly issued token.

+
+
Raise
+

com.vmware.oauth2.errors_client.InvalidRequest +if Token.IssueSpec is missing a required attribute, +includes an unsupported attribute value (other than +Token.IssueSpec.grant_type).

+
+
Raise
+

com.vmware.oauth2.errors_client.InvalidGrant +provided authorization grant (e.g., authorization code, resource +owner credentials) or refresh token is invalid, expired, revoked, +does not match the redirection URI used in the authorization +request, or was issued to another client.

+
+
Raise
+

com.vmware.oauth2.errors_client.InvalidScope +If the server is unwilling or unable to issue a token for all the +target services indicated by the Token.IssueSpec.resource +or Token.IssueSpec.audience attributes.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.authorization_client module

+

The com.vmware.vcenter.authorization_client module provides classes for +managing authorization.

+
+
+class com.vmware.vcenter.authorization_client.PrivilegeChecks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The PrivilegeChecks class provides methods for retrieving permission +privilege checks recorded by VPXD.

+

The privilege checks are recorded as VPXD makes them. The latest recorded +privilege check can be retrieved by a call to +com.vmware.vcenter.authorization.privilege_checks.Latest.get This allows +for querying of all privilege checks before or after that moment. For +example, if an administrator wants to record the privilege checks made by a +given UI workflow, they can do the following. 1. Retrieve the latest +privilege check and store it. 2. Go through the UI workflow. 3. Retrieve +the latest privilege check and store it. 4. Invoke +com.vmware.vcenter.authorization.PrivilegeChecks.list with the values from +steps 1) and 3) along with any additional filters.. This class was added in +vSphere API 8.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(objects=None, sessions=None, principals=None, privileges=None, op_ids=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrivilegeChecks.FilterSpec class contains attributes based on which +privilege checks can be filtered. Any privilege check matching at least one +of the conditions is returned. This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • objects (list of com.vmware.vapi.std_client.DynamicID or None) – IDs of the objects on which the privilege check was performed. This +attribute was added in vSphere API 8.0.0.0. +If None all objects match.

    • +

  • sessions (set of str or None) – Sessions for which the check was performed. This attribute was +added in vSphere API 8.0.0.0. +If None all sessions match.

    • +

  • principals (list of (PrivilegeChecks.Principal or None) or None) – Principles for which the privilege check was performed. The None +PrivilegeChecks.Principal value matches privilege checks for +anonymous sessions. This attribute was added in vSphere API +8.0.0.0. +If None all principles match.

    • +

  • privileges (set of str or None) – Privileges that were checked. This attribute was added in vSphere +API 8.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.cis.authz.Privilege. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.cis.authz.Privilege. +If None all privileges match.

    • +

  • op_ids (set of str or None) – OpIDs of the requests for which the check was performed. This +attribute was added in vSphere API 8.0.0.0. +If None all opIDs match.

    • +
+
+
+
+ +
+
+class Info(object=None, principal=None, privilege=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrivilegeChecks.Info class contains detailed information about a +privilege check. This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • object (com.vmware.vapi.std_client.DynamicID) – Object for which the privilege was checked. This attribute was +added in vSphere API 8.0.0.0.

    • +

  • principal (PrivilegeChecks.Principal or None) – Principal for which the privilege was checked. Note that the +username and domain specified are case-insensitive. This attribute +was added in vSphere API 8.0.0.0. +If None the privilege was checked for an unauthenticated session.

    • +

  • privilege (str) – Privilege that was checked. This attribute was added in vSphere API +8.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.authz.Privilege. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.cis.authz.Privilege.

    • +
+
+
+
+ +
+
+class IterationSpec(size=None, marker=None, end_marker=None, timeout_ms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrivilegeChecks.IterationSpec class contains attributes used to +break results into pages when listing privilege checks, see +PrivilegeChecks.list()). This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size (long or None) – Specifies the maximum number of results to return. This attribute +was added in vSphere API 8.0.0.0. +If None defaults to default page size, which is controlled by +config.vpxd.privilegeChecks.pageSize advanced option.

    • +

  • marker (str or None) – An opaque token which determines where the returned page should +begin. This attribute was added in vSphere API 8.0.0.0. +If None or empty, privilege checks will be returned from the first +record.

    • +

  • end_marker (str or None) – An opaque token which determines where the returned page should +end. This attribute was added in vSphere API 8.0.0.0. +If None or empty, privilege checks will be returned up to size, if +set, or up to the default page size.

    • +

  • timeout_ms (long or None) – Indicates how long the request should wait in ms for a matching +check if PrivilegeChecks.IterationSpec.marker is set, and +there no matching checks to be added to the result. This attribute +was added in vSphere API 8.0.0.0. +If None or empty, the request will not wait for additional +privilege checks and will return immediately.

    • +
+
+
+
+ +
+
+class ListResult(items=None, marker=None, truncated=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrivilegeChecks.ListResult class contains information about the +performed privilege checks, if there are any further privilege checks +available for reading, and if there are privilege checks potentially +missing. This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • items (list of PrivilegeChecks.Info) – Privilege checks that match the +specified:class:PrivilegeChecks.FilterSpec and +PrivilegeChecks.IterationSpec in chronological order as +they were performed. Each check is recorded only the first time it +is made. If more than one privilege check matches a given +PrivilegeChecks.FilterSpec (for example, two different +opIDs checked System.Read for the same object and the same +principal, a FilterSpec which specifies only the principal will +only contain the first check). This attribute was added in vSphere +API 8.0.0.0.

    • +

  • marker (str) –

    An opaque marker indicating the last returned privilege check. If +there are more privilege checks collected than were returned, the +next ones can be retrieved directly by passing this value to +another call to +com.vmware.vcenter.authorization.PrivilegeChecks.list.

    +

    . This attribute was added in vSphere API 8.0.0.0.

    +

    • +

  • truncated (bool) – In case PrivilegeChecks.IterationSpec.marker was specified +and valid, but the privilege check indicated by it is no longer +stored,. This attribute was added in vSphere API 8.0.0.0.

    • +
+
+
+
+ +
+
+class Principal(name=None, domain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrivilegeChecks.Principal class contains an identity management +principal ID. This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The principal’s username. This attribute was added in vSphere API +8.0.0.0.

    • +

  • domain (str) – The principal’s domain. This attribute was added in vSphere API +8.0.0.0.

    • +
+
+
+
+ +
+
+list(iteration=None, filter=None)
+

Queries the privilege checks matching given criteria. This method was +added in vSphere API 8.0.0.0.

+
+
Parameters
+
    +

  • iteration (PrivilegeChecks.IterationSpec or None) –

    Contains optional settings for pagination of the result. +if unset, the oldest privilege checks recorded are returned, paged +by the default page size.

    +

    The default page size can be changed from +config.vpxd.privilegeChecks.pageSize advanced option.

    +

    • +

  • filter (PrivilegeChecks.FilterSpec or None) – Contains optional settings by which the privilege checks should be +filtered. +if unset, recorded privilege checks matching the iteration spec are +returned.

    • +
+
+
Return type
+

PrivilegeChecks.ListResult

+
+
Returns
+

Detailed information about the privileges collected so far.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if filter or iteration spec contain invalid values.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the iteration spec contains a marker that could not be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Sessions.CollectPrivilegeChecks.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.authorization_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.certificate_management_client module

+

The com.vmware.vcenter.certificate_management_client module provides +classes to manage certificates.

+
+
+class com.vmware.vcenter.certificate_management_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.certificate_management_client.X509CertChain(cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The X509CertChain class contains x509 certificate chain. This class was +added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

cert_chain (list of str) – Certificate chain in base64 format. This attribute was added in +vSphere API 6.7.2.

+
+
+
+ +
+
+

com.vmware.vcenter.compute_client module

+

The com.vmware.vcenter.compute_client module provides classes for managing +compute policies.

+
+
+class com.vmware.vcenter.compute_client.Policies(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Policies class provides methods to manage compute policies. A +compute policy defines the intended behavior for a collection of vSphere +objects identified by a tag. A compute policy is an instance of a +capability. It is created by providing a value for the creation type +specified by the capability. See +com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vcenter.compute.Policy'
+

The resource type for the compute policy.

+
+ +
+
+class Summary(policy=None, name=None, description=None, capability=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policies.Summary class contains commonly used information about a +compute policy.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Identifier of the policy. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.Policy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.compute.Policy.

    • +

  • name (str) – Name of the policy.

    • +

  • description (str) – Description of the policy.

    • +

  • capability (str) – Identifier of the capability this policy is based on. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.compute.policies.Capability.

    • +
+
+
+
+ +
+
+create(spec)
+

Creates a new compute policy.

+
+
Parameters
+

spec (vmware.vapi.struct.VapiStruct) – Specification for the new policy to be created. The new policy will +be an instance of the capability that has the creation type (see +com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type) +equal to the type of the specified value (see spec). +The parameter must contain all the attributes defined in +com.vmware.vcenter.compute.policies_client.CreateSpec.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the newly created policy. Use this identifier to +get or destroy the policy. +The return value will be an identifier for the resource type: +com.vmware.vcenter.compute.Policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a policy with the same name is already present on this vCenter +server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if a parameter passed in the spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 100 policies are created.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ComputePolicy.Manage.

    • +
+
+
+
+ +
+
+delete(policy)
+

Deletes a specific compute policy.

+
+
Parameters
+

policy (str) – Identifier of the policy to be deleted. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.compute.Policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a policy with this identifier does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires ComputePolicy.Manage.

    • +
+
+
+
+ +
+
+get(policy)
+

Returns information about a specific compute policy.

+
+
Parameters
+

policy (str) – Identifier of the policy for which information should be retrieved. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.compute.Policy.

+
+
Return type
+

vmware.vapi.struct.VapiStruct

+
+
Returns
+

Detailed information about the specified compute policy. The +returned value can be converted to the information type of the +capability that this policy is based on. See +com.vmware.vcenter.compute.policies_client.Capabilities.Info.info_type. +The return value will contain all the attributes defined in +com.vmware.vcenter.compute.policies_client.Info.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a policy with this identifier does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+list()
+

Returns information about the compute policies available in this +vCenter server.

+
+
Return type
+

list of Policies.Summary

+
+
Returns
+

The list of compute policies available on this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.compute_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.consumption_domains_client module

+

The com.vmware.vcenter.consumption_domains_client module provides classes +for managing consumption domain capabilities offered by vCenter.

+
+
+class com.vmware.vcenter.consumption_domains_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.consumption_domains_client.Zones(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Zones class provides methods to manage consumption-domain zones. +This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(zone=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Zones.CreateSpec class contains the information required to create +a zone. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str) – Identifier of the zone. It has the following restrictions: 1. The +ID must be 63 characters or less (cannot be empty), 2. The ID must +begin and end with a lowercase alphanumeric character ([a-z0-9]), +3. The ID must only contain dashes (-), and lowercase alphanumerics +in between, 4. The ID must be unique within the vCenter in which it +is created. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • description (str or None) – Description of the zone. This attribute was added in vSphere API +8.0.0.1. +If None or empty, an empty description is set.

    • +
+
+
+
+ +
+
+class FilterSpec(zones=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Zones.FilterSpec class contains attributes used to filter the +results when listing configured zones, see Zones.list(). This class +was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

zones (set of str or None) – Matches all zones corresponding to the specified set of zone +identifiers. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. +If None or empty, results will not be filtered for specific zone +identifiers.

+
+
+
+ +
+
+class Info(description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Zones.Info class contains commonly used information about a +specific zone. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

description (str) – Description of the zone. This attribute was added in vSphere API +8.0.0.1.

+
+
+
+ +
+
+class ListItem(zone=None, info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Zones.ListItem class contains commonly used information about a +zone. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str) – Identifier of the zone. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • info (Zones.Info) – Information about the zone. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+class ListResult(items=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Zones.ListResult class contains the returned zones, see +Zones.list(). This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

items (list of Zones.ListItem) – The list of zones. This attribute was added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.consumption_domains.Zone'
+

The resource type for consumption-domain zones. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+
+create(spec)
+

Creates a zone based on the provided specifications. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+

spec (Zones.CreateSpec) – Specifications for the zone to be created.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the created zone. +The return value will be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a zone with the same identifier already exists in this vCenter +server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the input information in the createSpec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have Zones.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Zone.Manage.

    • +
+
+
+
+ +
+
+delete(zone)
+

Deletes the zone with the specified identifier. In order to delete a +zone, there must not be any workload running in that zone because +deleting the zone without removing all the dependencies on that zone +can cause undefined behavior for the entities depending on this zone to +be present. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

zone (str) – Identifier of the zone to be deleted. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no zone with the specified identifier is found in this vCenter +server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if there is a workload running in the specified zone and depends on +this zone to be present.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires Zones.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires Zone.Manage.

    • +
+
+
+
+ +
+
+get(zone)
+

Returns the information about a specific zone. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

zone (str) – Identifier of the zone for which information should be retrieved. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

+
+
Return type
+

Zones.Info

+
+
Returns
+

Detailed information about the specified zone.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a zone with this identifier does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zone requires System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+list(spec=None)
+

Returns information about the zones available on this vCenter server, +where the zones need to match Zones.FilterSpec. This method +was added in vSphere API 8.0.0.1.

+
+
Parameters
+

spec (Zones.FilterSpec or None) – Return only the zones matching the specified filters. +If None, the behavior is equivalent to a Zones.FilterSpec +with all attributes None, which means all zones are returned.

+
+
Return type
+

Zones.ListResult

+
+
Returns
+

The list of zones available on this vCenter that match the criteria +specified in Zones.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have all of the privileges described as +follows: - The resource com.vmware.vcenter.consumption_domains.Zone +referenced by the parameter zones in Zones.FilterSpec requires +System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +when unexpected error is encountered.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+

com.vmware.vcenter.crypto_manager_client module

+

The com.vmware.vcenter.crypto_manager_client module provides classes for +managing key providers and cryptographic keys.

+
+
+class com.vmware.vcenter.crypto_manager_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.datastore_client module

+
+
+class com.vmware.vcenter.datastore_client.DefaultPolicy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DefaultPolicy class provides methods related to storage policies +associated with datastore object. The DefaultPolicy.get() method +provides information about the default storage policy associated with the +specific datastore. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(datastore)
+

Returns the identifier of the current default storage policy associated +with the specified datastore. This method was added in vSphere API 6.7.

+
+
Parameters
+

datastore (str) – Identifier of the datastore for which the default policy is +requested. +The parameter must be an identifier for the resource type: +Datastore.

+
+
Return type
+

str or None

+
+
Returns
+

Identifier of the default storage policy associated with the +specified datastore. +The return value will be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. +this field is None if there is no default storage policy associated +with the datastore.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified datastore does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required priveleges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.datastore_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.deployment_client module

+
+
+class com.vmware.vcenter.deployment_client.ApplianceSize(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ApplianceSize class defines the vCenter Server Appliance sizes. +This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplianceSize instance.

+
+
+
+
+LARGE = ApplianceSize(string='LARGE')
+

Appliance size of ‘large’. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+MEDIUM = ApplianceSize(string='MEDIUM')
+

Appliance size of ‘medium’. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+SMALL = ApplianceSize(string='SMALL')
+

Appliance size of ‘small’. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+TINY = ApplianceSize(string='TINY')
+

Appliance size of ‘tiny’. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+XLARGE = ApplianceSize(string='XLARGE')
+

Appliance size of ‘extra large’. This class attribute was added in vSphere +API 7.0.0.0.

+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.ApplianceState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ApplianceState class defines the various states the vCenter +Appliance can be in. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplianceState instance.

+
+
+
+
+CONFIGURED = ApplianceState(string='CONFIGURED')
+

The appliance has been configured. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+CONFIG_IN_PROGRESS = ApplianceState(string='CONFIG_IN_PROGRESS')
+

The appliance is in the process of being configured. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+FAILED = ApplianceState(string='FAILED')
+

The appliance configuration has failed. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+INITIALIZED = ApplianceState(string='INITIALIZED')
+

The appliance is initialized and ready to be configured. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+NOT_INITIALIZED = ApplianceState(string='NOT_INITIALIZED')
+

The appliance is in the process of being initialized and not ready for +configuration. This class attribute was added in vSphere API 6.7.

+
+ +
+
+QUESTION_RAISED = ApplianceState(string='QUESTION_RAISED')
+

The deployment script has raised a question and is waiting for an answer to +continue with the appliance configuration. This class attribute was added +in vSphere API 6.7.

+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.ApplianceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ApplianceType class defines the vCenter appliance types. This +enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplianceType instance.

+
+
+
+
+PSC_EXTERNAL = ApplianceType(string='PSC_EXTERNAL')
+

An external Platform Services Controller. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+VCSA_EMBEDDED = ApplianceType(string='VCSA_EMBEDDED')
+

vCenter Server Appliance with an embedded Platform Services Controller. +This class attribute was added in vSphere API 6.7.

+
+ +
+
+VCSA_EXTERNAL = ApplianceType(string='VCSA_EXTERNAL')
+

vCenter Server Appliance with an external Platform Services Controller. +This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.CheckInfo(status=None, result=None, source_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckInfo class describes the result of the appliance deployment +check. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (CheckStatus) – Status of the check. This attribute was added in vSphere API 6.7.

    • +

  • result (Notifications or None) – Result of the check. This attribute was added in vSphere API 6.7. +This attribute will be None if result is not available at the +current step of the task.

    • +

  • source_info (SourceInfo or None) – Information collected from the source machine. This attribute was +added in vSphere API 7.0.0.0. +This attribute is used only for upgrade and migrate.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.CheckStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CheckStatus class defines the status of the checks. This +enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the CheckStatus instance.

+
+
+
+
+FAILED = CheckStatus(string='FAILED')
+

A fatal error was encountered when running the sanity checks. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+SUCCESS = CheckStatus(string='SUCCESS')
+

All checks have completed successfully. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.DataMigrationEstimate(estimated_export_time=None, estimated_import_time=None, required_free_disk_space_on_source=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataMigrationEstimate {class contains estimated time and disk space +required for the vCenter Server database migration. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • estimated_export_time (long) – The time estimated to export data from the source vCenter Server. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • estimated_import_time (long) – The time estimated to import data to the upgraded vCenter Server. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • required_free_disk_space_on_source (float) – The extra free space required on source vCenter Server. This +attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.DataMigrationInfo(core=None, core_events_tasks=None, all=None, core_events_tasks_with_deferred=None, all_with_deferred=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataMigrationInfo {class contains the disk space requirements and +time estimates for the different choices available to migrate the vCenter +Server data. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • core (DataMigrationEstimate) – Migrate only core data and configuration from vCenter Server. +Events, tasks, and stats will not be migrated. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • core_events_tasks (DataMigrationEstimate) – Migrate core, events, and tasks from vCenter Server. Stats will not +be migrated. This attribute was added in vSphere API 7.0.0.0.

    • +

  • all (DataMigrationEstimate) – Migrate all data from vCenter Server. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • core_events_tasks_with_deferred (DataMigrationEstimate or None) – Migrate core, events, and tasks from vCenter Server. Events and +tasks will be migrated after the upgrade. Stats will not be +migrated. This attribute was added in vSphere API 7.0.0.0. +This attribute will be available only if the source database is +using an external database.

    • +

  • all_with_deferred (DataMigrationEstimate or None) – Migrate all data from vCenter Server. Events, tasks, and stats will +be migrated after the upgrade. This attribute was added in vSphere +API 7.0.0.0. +This attribute will be available only if the source database is +using an external database.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.HistoryMigrationOption(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The HistoryMigrationOption class defines the vCenter history migration +option choices. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HistoryMigrationOption instance.

+
+
+
+
+ALL = HistoryMigrationOption(string='ALL')
+

All history data will be migrated along with the core data. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+EVENTS_TASKS = HistoryMigrationOption(string='EVENTS_TASKS')
+

Only event data and task data will be migrated along with the core data. +This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.HistoryMigrationSpec(data_set=None, defer_import=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HistoryMigrationSpec class defines how vCenter history data will be +migrated. vCenter History data includes

+
    +

  • Statistics

    • +

  • Events

    • +

  • Tasks

    • +
+

. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • data_set (HistoryMigrationOption) – Defines what part of vCenter historical data will be migrated along +with core data. This attribute was added in vSphere API 6.7.

    • +

  • defer_import (bool or None) – Defines how vCenter history will be migrated. If set to true, +vCenter history will be migrated separately after successful +upgrade(supported scenarios are upgrade from 6.0 or 6.5 to 6.7) or +migration, otherwise it will be migrated along with core data +during the upgrade or migration process. vCSA upgrade with deferred +import is no longer supported for target version 7.0 and later. +This attribute was added in vSphere API 6.7. +If None, vCenter historical data won’t be deferred and will be +migrated along with core data.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.ImportHistory(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ImportHistory class provides methods for managing the import of +vCenter historical data, e.g. Tasks, Events and Statistics, when is is +imported separately from the upgrade or migration process. This class was +added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ImportHistory.CreateSpec class contains information to create and +start vCenter historical data deferred import. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the vCenter history import task. This attribute was added +in vSphere API 6.7.

    • +

  • description (str) – Description of the vCenter history import task. This attribute was +added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Info(progress=None, result=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ImportHistory.Info class contains attributes to describe the state +of vCenter history import task. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • progress (com.vmware.cis.task_client.Progress) – The progress info of this task. This attribute was added in vSphere +API 6.7. +This attribute is optional and it is only relevant when the value +of CommonInfo#status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.FAILED, +com.vmware.cis.task_client.Status.BLOCKED, or +com.vmware.cis.task_client.Status.SUCCEEDED.

    • +

  • result (Notifications or None) – Result of the operation. If an operation reports partial results +before it completes, this attribute could be set before +the com.vmware.cis.task_client.CommonInfo.status has the +value com.vmware.cis.task_client.Status.SUCCEEDED. The +value could change as the operation progresses. This attribute was +added in vSphere API 6.7. +This attribute will be None if result is not available at the +current step of the operation.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

    • +

  • service (str) – Identifier of the service containing the operation. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.service. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.service.

    • +

  • operation (str) – Identifier of the operation associated with the task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.operation. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.operation.

    • +

  • parent (str or None) – Parent of the current task. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.task. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: com.vmware.cis.task. +This attribute will be None if the task has no parent.

    • +

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing +one the operation performed on. +This attribute will be None if the operation has no target or +multiple targets.

    • +

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

    • +

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The +value may change as the operation progresses.

    • +

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. +If None the description of why the operation failed will be +included in the result of the operation (see +com.vmware.cis.task_client.Info.result).

    • +

  • start_time (datetime.datetime) – Time when the operation is started. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.RUNNING, +com.vmware.cis.task_client.Status.BLOCKED, +com.vmware.cis.task_client.Status.SUCCEEDED, or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • end_time (datetime.datetime) – Time when the operation is completed. +This attribute is optional and it is only relevant when the value +of status is one of +com.vmware.cis.task_client.Status.SUCCEEDED or +com.vmware.cis.task_client.Status.FAILED.

    • +

  • user (str or None) – Name of the user who performed the operation. +This attribute will be None if the operation is performed by the +system.

    • +
+
+
+
+ +
+
+cancel()
+

Cancels the task for importing vCenter historical data. This method was +added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized to perform the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if vCenter historical data import task cannot be canceled at this +state. This can happen in the following cases:

+
    +

  • If historical data import has not been started yet because a not +running task cannot be canceled

    • +

  • If historical data import has already been completed because a +completed task cannot be canceled

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if vCenter historical data import task is already canceled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+get()
+

Get the current status of the vCenter historical data import. This +method was added in vSphere API 6.7.

+
+
Return type
+

ImportHistory.Info

+
+
Returns
+

Info structure containing the status information about the +historical data import status.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized to perform the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+pause()
+

Pauses the task for importing vCenter historical data. This method was +added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized to perform the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if vCenter historical data import task cannot be paused at this +time. Pause can be accepted only in +com.vmware.cis.task_client.Status.RUNNING state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if vCenter historical data import task is already paused

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+
+resume()
+

Resumes the task for importing vCenter historical data. This method was +added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized to perform the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if vCenter historical data import task cannot be resumed at this +state. Resume can be accepted only in +com.vmware.cis.task_client.Status.BLOCKED state

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if vCenter historical data import task is already resumed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error.

+
+
+
+ +
+
+start(spec=None)
+

Creates and starts task for importing vCenter historical data. This +method was added in vSphere API 6.7.

+
+
Parameters
+

spec (ImportHistory.CreateSpec or None) –

An optional ImportHistory.CreateSpec info that can be passed +for creating a new historical data import task and starts it. +If None, default value will be:

+
    +

  • name : vcenter.deployment.history.import

    • +

  • description : vCenter Server history import

    • +
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized to perform the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if vCenter historical data import task cannot be started at this +time. This can happen in the following cases:

+
    +

  • If historical data import has already been canceled because a +canceled task cannot be re-started

    • +

  • If historical data import has already been completed because a +completed task cannot be re-started

    • +

  • If historical data import has already been paused because a +paused task can only be resumed or canceled

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if vCenter historical data import task has already being started.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +Generic error

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.Install(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Install class provides methods to configure the installation of the +appliance. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class InstallSpec(vcsa_embedded=None, auto_answer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Install.InstallSpec class contains information used to configure +the appliance installation. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vcsa_embedded (Install.VcsaEmbeddedSpec) – Spec used to configure an embedded vCenter Server. This field +describes how the embedded vCenter Server appliance should be +configured. This attribute was added in vSphere API 6.7.

    • +

  • auto_answer (bool or None) – Use the default option for any questions that may come up during +appliance configuration. This attribute was added in vSphere API +6.7. +If None, will default to false.

    • +
+
+
+
+ +
+
+class VcsaEmbeddedSpec(standalone=None, replicated=None, ceip_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Install.VcsaEmbeddedSpec class contains information used to +configure an embedded standalone or replicated vCenter Server. This class +was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • standalone (StandaloneSpec or None) – Spec used to configure a standalone embedded vCenter Server. This +field describes how the standalone vCenter Server appliance should +be configured. This attribute was added in vSphere API 6.7. +If None, will default to None.

    • +

  • replicated (ReplicatedSpec or None) – Spec used to configure a replicated embedded vCenter Server. This +field describes how the replicated vCenter Server appliance should +be configured. This attribute was added in vSphere API 6.7. +If None, will default to None.

    • +

  • ceip_enabled (bool) – Whether CEIP should be enabled or disabled. This attribute was +added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+cancel()
+

Cancel the appliance installation that is in progress. This method was +added in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in CONFIG_IN_PROGRESS state and if the +operation is not INSTALL.

+
+
+
+ +
+
+check(spec)
+

Run sanity checks using the InstallSpec parameters passed. This method +was added in vSphere API 6.7.

+
+
Parameters
+

spec (Install.InstallSpec) – InstallSpec parameters to run sanity check with.

+
+
Return type
+

CheckInfo

+
+
Returns
+

CheckInfo containing the check results.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if external PSC credentials are not valid when configuring PSC to +replicate with an external existing PSC.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if external PSC credentials are not valid when configuring a +VCSA_EXTERNAL appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+
+get()
+

Get the parameters used to configure the ongoing appliance +installation. This method was added in vSphere API 6.7.

+
+
Return type
+

Install.InstallSpec

+
+
Returns
+

InstallSpec parameters being used to configure appliance install.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance is not in INSTALL_PROGRESS state.

+
+
+
+ +
+
+start(spec)
+

Start the appliance installation. This method was added in vSphere API +6.7.

+
+
Parameters
+

spec (Install.InstallSpec) – InstallSpec parameters to configure the appliance install.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the partner PSC credentials are not valid when configuring PSC +to replicate with partner PSC.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if external PSC credentials are not valid when configuring a +VCSA_EXTERNAL appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.LocationSpec(hostname=None, https_port=None, ssl_thumbprint=None, ssl_verify=None, username=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocationSpec class is used to pass the container ESXi or vCenter +server of the VM to patch the size of this appliance. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The IP address or DNS resolvable name of the container. This +attribute was added in vSphere API 6.7.

    • +

  • https_port (long or None) – The HTTPS port of the container. This attribute was added in +vSphere API 6.7. +If None, port 443 will be used.

    • +

  • ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for +verification. This attribute was added in vSphere API 6.7. +This attribute is only relevant if sslVerify is None or has the +value true.

    • +

  • ssl_verify (bool or None) – SSL verification should be enabled or disabled. If sslVerify is +true and and sslThumbprint is None, the CA certificate will be +used for verification. If sslVerify is true and +sslThumbprint is set then the thumbprint will be used for +verification. No verification will be performed if sslVerify +value is set to false. This attribute was added in vSphere API 6.7. +If None, ssl_verify true will be used.

    • +

  • username (str) – The administrator account on the host. This attribute was added in +vSphere API 6.7.

    • +

  • password (str) – The administrator account password. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.Migrate(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Migrate class provides methods to configure the migration of this +appliance from an existing vCenter for Windows. This class was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class MigrateSpec(source_vc_windows=None, existing_migration_assistant=None, history=None, vcsa_embedded=None, psc=None, active_directory=None, auto_answer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Migrate.MigrateSpec class contains the fields to migrate an +existing vCenter Server for Windows to an appliance. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source_vc_windows (Migrate.SourceVcWindows) – Information specific to the Windows vCenter Server. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • existing_migration_assistant (Migrate.MigrationAssistantSpec) – Information specific to the Migration Assistant that is running on +the Windows vCenter Server. This attribute was added in vSphere API +7.0.0.0.

    • +

  • history (HistoryMigrationSpec or None) –

    Determines how vCenter history will be migrated during the +migration process. vCenter history consists of:

    +
      +

    • Statistics

      • +

    • Events

      • +

    • Tasks

      • +
    +

    By default only core data will be migrated. Use this spec to define +which part of vCenter history data will be migrated and when. This +attribute was added in vSphere API 7.0.0.0. +If None, only core database content will be migrated.

    +

    • +

  • vcsa_embedded (Migrate.VcsaEmbeddedSpec or None) – Information specific to an embedded vCenter Server. This attribute +was added in vSphere API 7.0.0.0. +Only required if the vCenter Server that is going to be migrated is +an embedded vCenter Server.

    • +

  • psc (Migrate.PscSpec or None) – Information specific to a Platform Services Controller. This +attribute was added in vSphere API 7.0.0.0. +Only required if the vCenter Server that is going to be migrated is +a Platform Services Controller.

    • +

  • active_directory (com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec or None) – Information specific to the Active Directory server to which the +source windows vCenter Server is joined. This attribute was added +in vSphere API 7.0.0.0. +If None, existing appliance will not be joined to an Active +Directory.

    • +

  • auto_answer (bool or None) – Use the default option for any questions that may come up during +appliance configuration. This attribute was added in vSphere API +7.0.0.0. +If None, will default to false.

    • +
+
+
+
+ +
+
+class MigrationAssistantSpec(https_port=None, ssl_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Migrate.MigrationAssistantSpec class contains the information +needed to connect to the Migration Assistant that is running on the source +windows vCenter Server machine. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • https_port (long or None) – The HTTPS port being used by Migration Assistant. This attribute +was added in vSphere API 7.0.0.0. +If None, port 9123 will be used.

    • +

  • ssl_thumbprint (str) – SHA1 thumbprint of the Migration Assistant SSL certificate that +will be used for verification. This attribute was added in vSphere +API 7.0.0.0.

    • +
+
+
+
+ +
+
+class PscSpec(ceip_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Migrate.PscSpec class contains information used to migrate a +windows Platform Service Controller to Platform Service Controller +appliance. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ceip_enabled (bool) – Customer experience improvement program should be enabled or +disabled for this Platform Services Controller migration. This +attribute was added in vSphere API 7.0.0.0.

+
+
+
+ +
+
+class SourceVcWindows(hostname=None, username=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Migrate.SourceVcWindows class contains information about the +windows vCenter Server that is going to be migrated. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The IP address or DNS resolvable name of the source Windows +machine. This attribute was added in vSphere API 7.0.0.0.

    • +

  • username (str) – The SSO account with administrative privilege to perform the +migration operation. This attribute was added in vSphere API +7.0.0.0.

    • +

  • password (str) – The SSO administrator account password. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class VcsaEmbeddedSpec(ceip_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Migrate.VcsaEmbeddedSpec class contains information used to migrate +an embedded vCenter Server for Windows to embedded vCenter Server +appliance. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ceip_enabled (bool) – Customer experience improvement program should be enabled or +disabled for this embedded vCenter Server migration. This attribute +was added in vSphere API 7.0.0.0.

+
+
+
+ +
+
+cancel()
+

Cancel the appliance migration that is in progress. This method was +added in vSphere API 7.0.0.0.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in CONFIG_IN_PROGRESS state and if the +operation is not INSTALL.

+
+
+
+ +
+
+check(spec)
+

Run sanity checks using the MigrateSpec parameters passed. This method +was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (Migrate.MigrateSpec) – MigrateSpec parameters to run sanity check on.

+
+
Return type
+

CheckInfo

+
+
Returns
+

CheckInfo containing the check results.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if migration assistant credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+
+get()
+

Get the MigrateSpec parameters used to configure the ongoing appliance +migration. This method was added in vSphere API 7.0.0.0.

+
+
Return type
+

Migrate.MigrateSpec

+
+
Returns
+

MigrateSpec parameters being used to configure appliance migration.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance is not in MIGRATE_PROGRESS state.

+
+
+
+ +
+
+start(spec)
+

Start the appliance migration. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+

spec (Migrate.MigrateSpec) – MigrateSpec parameters to configure the appliance migration.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if migration assistant credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.Notification(id=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class contains attributes to describe any +info/warning/error messages that Tasks can raise. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The notification id. This attribute was added in vSphere API 6.7.

    • +

  • time (datetime.datetime or None) – The time the notification was raised/found. This attribute was +added in vSphere API 6.7. +Only set if the time information is available.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message. This attribute was added in vSphere API +6.7.

    • +

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. This attribute was added in vSphere +API 6.7. +Only set for warnings and errors.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the task. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. This attribute was added in +vSphere API 6.7. +Only set if an info was reported by the task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. This attribute was added in +vSphere API 6.7. +Only set if an warning was reported by the task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. This attribute was added in +vSphere API 6.7. +Only set if an error was reported by the task.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.Operation(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Operation class defines the supported vCenter appliance deployment +operations. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Operation instance.

+
+
+
+
+INSTALL = Operation(string='INSTALL')
+

The appliance installation is in progress. This class attribute was added +in vSphere API 6.7.

+
+ +
+
+MIGRATE = Operation(string='MIGRATE')
+

The appliance migration is in progress. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+RESTORE = Operation(string='RESTORE')
+

The appliance restoration is in progress. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+ROLLBACK = Operation(string='ROLLBACK')
+

The appliance is being rolled back to an unconfigured state. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+UPGRADE = Operation(string='UPGRADE')
+

The appliance upgrade is in progress. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.Question(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Question class provides methods to get the question raised during +deployment and to answer them. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class AnswerSpec(question_id=None, answer_val=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Question.AnswerSpec class contains attributes to describe the +answer to a raised question. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • question_id (str) – Id of the question being answered. This attribute was added in +vSphere API 6.7.

    • +

  • answer_val (str) – The answer value. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class Info(questions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Question.Info class contains attributes to describe questions +raised during the deployment process. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

questions (list of Question.Question) – One or more questions raised during the deployment. This attribute +was added in vSphere API 6.7.

+
+
+
+ +
+
+class Question(id=None, question=None, type=None, default_answer=None, possible_answers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Question.Question class contains attributes to describe a +deployment question. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Id of the question raised. This attribute was added in vSphere API +6.7.

    • +

  • question (com.vmware.vapi.std_client.LocalizableMessage) – Message describing the question. This attribute was added in +vSphere API 6.7.

    • +

  • type (Question.QuestionType) – Type of the question raised. This attribute was added in vSphere +API 6.7.

    • +

  • default_answer (str) – Default answer value. This attribute was added in vSphere API 6.7.

    • +

  • possible_answers (list of str) – Possible answers values. This attribute was added in vSphere API +6.7.

    • +
+
+
+
+ +
+
+class QuestionType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Question.QuestionType class defines the type of the question +raised. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the QuestionType instance.

+
+
+
+
+ABORT_RETRY_IGNORE = QuestionType(string='ABORT_RETRY_IGNORE')
+

Question with answer values Abort/Retry/Ignore. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+OK_CANCEL = QuestionType(string='OK_CANCEL')
+

Question with answer values Ok/Cancel. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+YES_NO = QuestionType(string='YES_NO')
+

Question with answer values Yes/No. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+answer(spec)
+

Supply answer to the raised question. This method was added in vSphere +API 6.7.

+
+
Parameters
+

spec (Question.AnswerSpec) – AnswerSpec with the answer to the raised question.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is NOT in QUESTION_RAISED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +if answer file could not be created.

+
+
+
+ +
+
+get()
+

Get the question that was raised during the configuration. This method +was added in vSphere API 6.7.

+
+
Return type
+

Question.Info

+
+
Returns
+

Info structure containing the question.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in QUESTION_RAISED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +if questions could not be retrieved although the appliance is in +QUESTION_RAISED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.RemotePscSpec(psc_hostname=None, https_port=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The RemotePscSpec class contains information used to configure an +external vCenter Server that registers with a remote PSC. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • psc_hostname (str) – The IP address or DNS resolvable name of the remote PSC to which +this configuring vCenter Server will be registered to. This +attribute was added in vSphere API 6.7.

    • +

  • https_port (long or None) – The HTTPS port of the external PSC appliance. This attribute was +added in vSphere API 6.7. +If None, port 443 will be used.

    • +

  • sso_admin_password (str) – The SSO administrator account password. This attribute was added in +vSphere API 6.7.

    • +

  • ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for +verification when ssl_verify field is set to true. This attribute +was added in vSphere API 6.7. +This attribute is only relevant if sslVerify is None or has the +value true.

    • +

  • ssl_verify (bool or None) – SSL verification should be enabled or disabled. If sslVerify is +true and and sslThumbprint is None, the CA certificate will be +used for verification. If sslVerify is true and +sslThumbprint is set then the thumbprint will be used for +verification. No verification will be performed if sslVerify +value is set to false. This attribute was added in vSphere API 6.7. +If None, sslVerify true will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.ReplicatedPscSpec(sso_site_name=None, partner_hostname=None, https_port=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ReplicatedPscSpec class contains information used to check if the +configuring PSC can be replicated to the remote PSC. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • sso_site_name (str or None) – The SSO sitename that will be used in PSC replication. This +attribute was added in vSphere API 6.7. +If None, default-first-site will be used.

    • +

  • partner_hostname (str) – The IP address or DNS resolvable name of the partner PSC appliance. +This attribute was added in vSphere API 6.7.

    • +

  • https_port (long or None) – The HTTPS port of the external PSC appliance. This attribute was +added in vSphere API 6.7. +If None, port 443 will be used.

    • +

  • sso_admin_password (str) – The SSO administrator account password. This attribute was added in +vSphere API 6.7.

    • +

  • ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for +verification. This attribute was added in vSphere API 6.7. +This attribute is only relevant if sslVerify is None or has the +value true.

    • +

  • ssl_verify (bool or None) – SSL verification should be enabled or disabled. This attribute was +added in vSphere API 6.7. +If None, ssl_verify true will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.ReplicatedSpec(partner_hostname=None, https_port=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ReplicatedSpec class contains information used to check if the +configuring vCenter Server can be replicated to the remote PSC. This class +was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • partner_hostname (str) – The IP address or DNS resolvable name of the partner PSC appliance. +This attribute was added in vSphere API 6.7.

    • +

  • https_port (long or None) – The HTTPS port of the external PSC appliance. This attribute was +added in vSphere API 6.7. +If None, port 443 will be used.

    • +

  • sso_admin_password (str) – The SSO administrator account password. This attribute was added in +vSphere API 6.7.

    • +

  • ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for +verification. This attribute was added in vSphere API 6.7. +This attribute is only relevant if sslVerify is None or has the +value true.

    • +

  • ssl_verify (bool or None) – SSL verification should be enabled or disabled. This attribute was +added in vSphere API 6.7. +If None, ssl_verify true will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.SourceInfo(hostname=None, version=None, deployment_type=None, deployment_size=None, sso_domain_name=None, active_directory_domain=None, dns_servers=None, data_migration_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SourceInfo {class contains information about the source vCenter +Server system and the database migration options. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The IP address or DNS resolvable name of the source vCenter Server. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • version (str) – Source vCenter Server version. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • deployment_type (ApplianceType) – Deployment type of the source vCenter Server. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • deployment_size (ApplianceSize) – Deployment size of the source vCenter Server. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • sso_domain_name (str) – The SSO domain name of the source vCenter Server. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • active_directory_domain (str) – The domain name of the Active Directory server to which the source +vCenter Server is joined. This attribute was added in vSphere API +7.0.0.0.

    • +

  • dns_servers (list of str) – IP addresses of the DNS servers of the Active Directory server. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • data_migration_info (DataMigrationInfo or None) – Contains all the available migrate options, estimated export and +import time and the space required to migrate the data. This +attribute was added in vSphere API 7.0.0.0. +This attribute will be available if estimate data is available for +the appliance.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.StandalonePscSpec(sso_site_name=None, sso_admin_password=None, sso_domain_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StandalonePscSpec class contains information used to configure a +standalone PSC appliance. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • sso_site_name (str or None) – The SSO site name used for this PSC. This attribute was added in +vSphere API 6.7. +If None, default-first-site will be used.

    • +

  • sso_admin_password (str) – The SSO administrator account password. This attribute was added in +vSphere API 6.7.

    • +

  • sso_domain_name (str or None) – The SSO domain name to be used to configure this appliance. This +attribute was added in vSphere API 6.7. +If None, vsphere.local will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.StandaloneSpec(sso_admin_password=None, sso_domain_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StandaloneSpec class contains information used to configure a +standalone embedded vCenter Server appliance. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • sso_admin_password (str) – The SSO administrator account password. This attribute was added in +vSphere API 6.7.

    • +

  • sso_domain_name (str or None) – The SSO domain name to be used to configure this appliance. This +attribute was added in vSphere API 6.7. +If None, vsphere.local will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.deployment_client.Upgrade(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Upgrade class provides methods to configure the upgrade of this +appliance from an existing vCenter appliance. This class was added in +vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class PscSpec(ceip_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Upgrade.PscSpec class contains information used to upgrade a +Platform Service Controller appliance. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ceip_enabled (bool) – Customer experience improvement program should be enabled or +disabled for this Platform Services Controller upgrade. This +attribute was added in vSphere API 6.7.

+
+
+
+ +
+
+class SourceApplianceSpec(hostname=None, https_port=None, ssl_thumbprint=None, ssl_verify=None, sso_admin_username=None, sso_admin_password=None, root_password=None, ssh_verify=None, ssh_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Upgrade.SourceApplianceSpec class contains information used to +connect to the appliance used as the source for an upgrade. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The IP address or DNS resolvable name of the source appliance. This +attribute was added in vSphere API 6.7.

    • +

  • https_port (long or None) – The HTTPS port of the source appliance. This attribute was added in +vSphere API 6.7. +If None, port 443 will be used.

    • +

  • ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for +verification. This attribute was added in vSphere API 6.7. +This attribute is only relevant if sslVerify is None or has the +value true.

    • +

  • ssl_verify (bool or None) – SSL verification should be enabled or disabled for the source +appliance validations. By default it is enabled and will use SSL +certificate for verification. If thumbprint is provided, will use +thumbprint for the verification. This attribute was added in +vSphere API 6.7. +If None, ssl_verify true will be used.

    • +

  • sso_admin_username (str) – The SSO administrator account on the source appliance. This +attribute was added in vSphere API 6.7.

    • +

  • sso_admin_password (str) – The SSO administrator account password. This attribute was added in +vSphere API 6.7.

    • +

  • root_password (str) – The password of the root user on the source appliance. This +attribute was added in vSphere API 6.7.

    • +

  • ssh_verify (bool or None) – Appliance SSH verification should be enabled or disabled. By +default it is disabled and will not use any verification. If +thumbprint is provided, thumbprint verification will be performed. +This attribute was added in vSphere API 6.7. +If None, ssh_verify true will be used.

    • +

  • ssh_thumbprint (str or None) – MD5 thumbprint of the server SSH key will be used for verification. +This attribute was added in vSphere API 6.7. +This attribute is only relevant if sshVerify is None or has the +value true.

    • +
+
+
+
+ +
+
+class UpgradeSpec(source_appliance=None, source_location=None, history=None, vcsa_embedded=None, psc=None, auto_answer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Upgrade.UpgradeSpec class contains information used to configure +the appliance upgrade. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source_appliance (Upgrade.SourceApplianceSpec) – Source appliance spec. This attribute was added in vSphere API 6.7.

    • +

  • source_location (LocationSpec) – Source location spec. This attribute was added in vSphere API 6.7.

    • +

  • history (HistoryMigrationSpec or None) –

    Determines how vCenter history will be migrated during the upgrade +process. vCenter history consists of:

    +
      +

    • Statistics

      • +

    • Events

      • +

    • Tasks

      • +
    +

    By default only core data will be migrated. Use this spec to define +which part of vCenter history data will be migrated and when. This +attribute was added in vSphere API 6.7. +If None, only core database content will be migrated.

    +

    • +

  • vcsa_embedded (Upgrade.VcsaEmbeddedSpec or None) – Information that are specific to this embedded vCenter Server. This +attribute was added in vSphere API 6.7. +If None, ceip_enabled for embedded vcenter server upgrade will +default to enabled.

    • +

  • psc (Upgrade.PscSpec or None) – Information that are specific to this Platform Services Controller. +This attribute was added in vSphere API 6.7. +If None, ceip_enabled for psc upgrade will default to enabled.

    • +

  • auto_answer (bool or None) – Use the default option for any questions that may come up during +appliance configuration. This attribute was added in vSphere API +6.7. +If None, will default to false.

    • +
+
+
+
+ +
+
+class VcsaEmbeddedSpec(ceip_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Upgrade.VcsaEmbeddedSpec class contains information used to upgrade +a Embedded vCenter Server appliance. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ceip_enabled (bool) – Customer experience improvement program should be enabled or +disabled for this embedded vCenter Server upgrade. This attribute +was added in vSphere API 6.7.

+
+
+
+ +
+
+cancel()
+

Cancel the appliance upgrade that is in progress. This method was added +in vSphere API 6.7.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in CONFIG_IN_PROGRESS state and if the +operation is not INSTALL.

+
+
+
+ +
+
+check(spec)
+

Run sanity checks using the UpgradeSpec parameters passed. This method +was added in vSphere API 6.7.

+
+
Parameters
+

spec (Upgrade.UpgradeSpec) – UpgradeSpec parameters to run sanity check on.

+
+
Return type
+

CheckInfo

+
+
Returns
+

CheckInfo containing the check results.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if source credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if source container credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+
+get()
+

Get the UpgradeSpec parameters used to configure the ongoing appliance +upgrade. This method was added in vSphere API 6.7.

+
+
Return type
+

Upgrade.UpgradeSpec

+
+
Returns
+

UpgradeSpec parameters being used to configure appliance upgrade.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance is not in UPGRADE_PROGRESS state.

+
+
+
+ +
+
+start(spec)
+

Start the appliance installation. This method was added in vSphere API +6.7.

+
+
Parameters
+

spec (Upgrade.UpgradeSpec) – UpgradeSpec parameters to configure the appliance upgrade.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if source credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if source container credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.deployment_client.VerificationMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The VerificationMode class defines the verification modes for SSL +certificates or SSH connections. This enumeration was added in vSphere API +6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the VerificationMode instance.

+
+
+
+
+NONE = VerificationMode(string='NONE')
+

No verification will be performed. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+THUMBPRINT = VerificationMode(string='THUMBPRINT')
+

Passed thumbprint will be used for verification. This class attribute was +added in vSphere API 6.7.

+
+ +
+ +
+
+

com.vmware.vcenter.guest_client module

+

The com.vmware.vcenter.guest_client module provides classes for managing +guest customization specifications in the vCenter Server.

+
+
+class com.vmware.vcenter.guest_client.AdapterMapping(mac_address=None, adapter=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AdapterMapping class specifies the association between a virtual +network adapter and its IP settings. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • mac_address (str or None) –

    The MAC address of a network adapter being customized.

    +

    In vSphere 7.0 series, the MAC addresses must be specified in the +ascending order of pciSlotNumber, otherwise a MAC address mismatch +error will be reported. For further details, see the +https://kb.vmware.com/s/article/87648

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, the customization process maps the the settings from the +list of AdapterMappings.IPSettings in the +CustomizationSpec.interfaces to the virtual machine’s +network adapters, in PCI slot order. The first virtual network +adapter on the PCI bus is assigned interfaces[0].IPSettings, the +second adapter is assigned interfaces[1].IPSettings, and so on.

    +

    • +

  • adapter (IPSettings) – The IP settings for the associated virtual network adapter. This +attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.CloudConfiguration(type=None, cloudinit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Guest customization settings to customize a guest operating system with +cloud configuration.

+

The CloudConfiguration class contains the type of cloud configuration +and the settings of that cloud configuration.. This class was added in +vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CloudConfiguration.Type class specifies different types of the +cloud configuration. This enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+CLOUDINIT = Type(string='CLOUDINIT')
+

cloud-init configuration. This class attribute was added in vSphere API +7.0.3.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.CloudinitConfiguration(metadata=None, userdata=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Guest customization settings to customize a Linux guest operating system +with raw cloud-init data.

+

The CloudinitConfiguration class contains settings that configure a +Linux machine with raw cloud-init data. See +https://cloudinit.readthedocs.io/en/latest about cloud-init.. This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.ConfigurationSpec(windows_config=None, linux_config=None, cloud_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConfigurationSpec class specifies the settings for customizing a +guest operating system. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • windows_config (WindowsConfiguration or None) – Guest customization specification for a Windows guest operating +system. This attribute was added in vSphere API 7.0.0.0. +If None, ConfigurationSpec.linux_config or +ConfigurationSpec.cloud_config must be set. Otherwise, an +appropriate fault will be thrown.

    • +

  • linux_config (LinuxConfiguration or None) – Guest customization specification for a linux guest operating +system. This attribute was added in vSphere API 7.0.0.0. +If None, ConfigurationSpec.windows_config or +ConfigurationSpec.cloud_config must be set. Otherwise, an +appropriate fault will be thrown.

    • +

  • cloud_config (CloudConfiguration or None) – Guest customization specification with cloud configuration. This +attribute was added in vSphere API 7.0.3.0. +If None, ConfigurationSpec.windows_config or +ConfigurationSpec.linux_config must be set. Otherwise, an +appropriate fault will be thrown.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.CustomizationSpec(configuration_spec=None, global_dns_settings=None, interfaces=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpec class contains information required to customize +a virtual machine when deploying it or migrating it to a new host. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • configuration_spec (ConfigurationSpec) – Settings to be applied to the guest during the customization. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • global_dns_settings (GlobalDNSSettings) – Global DNS settings constitute the DNS settings that are not +specific to a particular virtual network adapter. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • interfaces (list of AdapterMapping) – IP settings that are specific to a particular virtual network +adapter. The AdapterMapping class maps a network adapter’s +MAC address to its IPSettings. May be empty if there are +no network adapters, else should match number of network adapters +configured for the VM. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.CustomizationSpecs(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The CustomizationSpecs class provides methods to manage guest +customization specifications in the vCenter Server. This class was added in +vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(spec=None, description=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpecs.CreateSpec class contains specification +information and specification object that can be passed to the +CustomizationSpecs.create() method. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • spec (CustomizationSpec) – The specification object. This attribute was added in vSphere API +7.0.0.0.

    • +

  • description (str) – Description of the specification. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • name (str) – Name of the specification. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class FilterSpec(names=None, os_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpecs.FilterSpec class contains attributes used to +filter the results when listing guest customization specifications (see +CustomizationSpecs.list()). If multiple attributes are specified, +only guest customization specifications matching all of the attributes +match the filter. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • names (set of str or None) – Names that guest customization specifications must have to match +the filter (see CustomizationSpecs.Summary.name). This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.guest.CustomizationSpec. When methods return +a value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.guest.CustomizationSpec. +If None or empty, guest customization specifications with any name +match the filter.

    • +

  • os_type (CustomizationSpecs.OsType or None) – Guest operating system type that guest customization specifications +must have to match the filter (see +CustomizationSpecs.Summary.os_type). This attribute was +added in vSphere API 6.7.1. +If None, guest customization specifications with any guest +operating system type match the filter.

    • +
+
+
+
+ +
+
+class Format(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CustomizationSpecs.Format class specifies the formats the +customization specification can be exported to. This enumeration was added +in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Format instance.

+
+
+
+
+JSON = Format(string='JSON')
+

JSON format. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+XML = Format(string='XML')
+

XML format. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(last_modified=None, spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpecs.Info class describes a guest customization +specification and the timestamp when it was last modified. This is returned +by the CustomizationSpecs.get() method. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • last_modified (datetime.datetime) – Time when the specification was last modified. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • spec (CustomizationSpecs.Spec) – The Spec object including specification and metadata information. +This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class Metadata(description=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpecs.Metadata class contains metadata i.e. name and +description related to a customization specification. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the specification. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • name (str) – Name of the specification. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class OsType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CustomizationSpecs.OsType class defines the types of guest +operating systems for which guest customization is supported. This +enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the OsType instance.

+
+
+
+
+LINUX = OsType(string='LINUX')
+

A customization specification for a Linux guest operating system. This +class attribute was added in vSphere API 6.7.1.

+
+ +
+
+WINDOWS = OsType(string='WINDOWS')
+

A customization specification for a Windows guest operating system. This +class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.guest.CustomizationSpec'
+

The resource type for a vCenter guest customization specification. This class +attribute was added in vSphere API 6.7.1.

+
+ +
+
+class Spec(fingerprint=None, spec=None, description=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpecs.Spec class contains the specification +information and specification object. This is passed to the +CustomizationSpecs.set() method. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • fingerprint (str) – The fingerprint is a unique identifier for a given version of the +configuration. Each change to the configuration will update this +value. A client cannot change this value. If specified when +updating a specification, the changes will only be applied if the +current fingerprint matches the specified fingerprint. This field +can be used to guard against updates that has happened between the +specification content was read and until it is applied. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • spec (CustomizationSpec) – The specification object. This attribute was added in vSphere API +7.0.0.0.

    • +

  • description (str) – Description of the specification. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • name (str) – Name of the specification. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(name=None, description=None, os_type=None, last_modified=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CustomizationSpecs.Summary class contains commonly used information +about a guest customization specification. This class was added in vSphere +API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the guest customization specification. This attribute was +added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec.

    • +

  • description (str) – Description of the guest customization specification. This +attribute was added in vSphere API 6.7.1.

    • +

  • os_type (CustomizationSpecs.OsType) – Guest operating system type for which that this guest customization +specification applies. This attribute was added in vSphere API +6.7.1.

    • +

  • last_modified (datetime.datetime) – Date and tme when this guest customization specification was last +modified. This attribute was added in vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+create(spec)
+

Creates a customization specification. This method was added in vSphere +API 7.0.0.0.

+
+
Parameters
+

spec (CustomizationSpecs.CreateSpec) – The information i.e. name, description and the settings i.e +hostname, ip address etc for the new customization specification +that needs to be created.

+
+
Return type
+

str

+
+
Returns
+

The name of the customization specification that is created. +The return value will be an identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a customization specification is already present with the same +name.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified specification is not a valid one.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ModifyCustSpecs.

    • +
+
+
+
+ +
+
+delete(name)
+

Deletes a customization specification with the specified identifier. +This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

name (str) – The name of the customization specification that needs to be +deleted. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a customization specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ModifyCustSpecs.

    • +
+
+
+
+ +
+
+export(name, format)
+

Returns the content of the customization specification in the specified +format. Note that any passwords in the customization specification will +be set to blank values during the export method. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • name (str) – The name of the customization specification that has to be +returned. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec.

    • +

  • format (CustomizationSpecs.Format) – The format in which the customization specification has to be +returned.

    • +
+
+
Return type
+

str

+
+
Returns
+

The string representation of the customization specification in the +specified format.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If value of format is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the customization specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ReadCustSpecs.

    • +
+
+
+
+ +
+
+get(name)
+

Returns the guest customization specification from vCenter with the +specified identifier. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

name (str) – The name of the customization specification. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec.

+
+
Return type
+

CustomizationSpecs.Info

+
+
Returns
+

A customization spec with the specified identifier.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a customization specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ReadCustSpecs.

    • +
+
+
+
+ +
+
+import_specification(customization_spec)
+

Converts a well formatted string to a +CustomizationSpecs.CreateSpec. The resulting object can be +passed to CustomizationSpecs.create() method. This method was +added in vSphere API 7.0.0.0.

+
+
Parameters
+

customization_spec (str) – content to be converted to the spec.

+
+
Return type
+

CustomizationSpecs.CreateSpec

+
+
Returns
+

A proper specification of type +CustomizationSpecs.CreateSpec

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified content cannot be properly converted into a proper +valid CustomizationSpecs.CreateSpec object.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ModifyCustSpecs.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 1000 visible (subject to permission +checks) guest customization specifications in vCenter matching the +CustomizationSpecs.FilterSpec. This method was added in +vSphere API 6.7.1.

+
+
Parameters
+

filter (CustomizationSpecs.FilterSpec or None) – Specification of matching guest customization specifications for +which information should be returned. +If None, the behavior is equivalent to a +CustomizationSpecs.FilterSpec with all attributes None +which means all guest customization specifications match the +filter.

+
+
Return type
+

list of CustomizationSpecs.Summary

+
+
Returns
+

Commonly used information about the guest customization +specifications matching the CustomizationSpecs.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the CustomizationSpecs.FilterSpec.os_type attribute +contains a value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1000 guest customization specifications match the +CustomizationSpecs.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ReadCustSpecs.

    • +
+
+
+
+ +
+
+set(name, spec)
+

Sets an existing specification, possibly after retrieving (by using +CustomizationSpecs.get()) and editing it. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • name (str) – The name of the customization specification that needs to be set. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.guest.CustomizationSpec.

    • +

  • spec (CustomizationSpecs.Spec) – The new specification that will overwrite the existing +specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If, based on the item’s fingerprint value, the set process detects +that the specification has changed since its retrieval, then the +method throws InvalidArgument exception to warn the client that he +might overwrite another client’s change.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the settings in spec are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a customization specification is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires +VirtualMachine.Provisioning.ModifyCustSpecs.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.guest_client.Domain(type=None, workgroup=None, domain=None, domain_username=None, domain_password=None, domain_ou=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Domain class specifies the information needed to join a workgroup +or domain. This structure maps to the Identification key in the sysprep.xml +answer file. These values are transferred into the sysprep.xml file that +VirtualCenter stores on the target virtual disk. For more information about +performing unattended installation, check +https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Domain.Type) – The type of network to join after the customization. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • workgroup (str) – The workgroup that the virtual machine should join. This attribute +was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Domain.Type.WORKGROUP.

    • +

  • domain (str) – The domain to which the virtual machine should be joined. This +attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Domain.Type.DOMAIN.

    • +

  • domain_username (str) – The domain user that has permission to join the domain after +virtual machine is joined. This attribute was added in vSphere API +7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Domain.Type.DOMAIN.

    • +

  • domain_password (str) – The domain user password that has permission to join the +Domain.domain_username after customization. This attribute +was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Domain.Type.DOMAIN.

    • +

  • domain_ou (str or None) – The MachineObjectOU which specifies the full LDAP path name of the +OU to which the virtual machine belongs. Refer to: +https://docs.microsoft.com/en-us/windows-hardware/customize +desktop/unattend/microsoft-windows-unattendedjoin- +identification-machineobjectou. This attribute was added in vSphere +API 8.0.2.0. +This attribute is optional and it is only relevant when the value +of type is Domain.Type.DOMAIN.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Domain.Type class defines the types of network the virtual machine +should join to after the customization is completed. This enumeration was +added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DOMAIN = Type(string='DOMAIN')
+

The virtual machine should be be joined to a domain. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+WORKGROUP = Type(string='WORKGROUP')
+

The virtual machine should be be joined to a workgroup. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.GlobalDNSSettings(dns_suffix_list=None, dns_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The GlobalDNSSettings class specifies a collection of global IP +settings in the guest operating system. In Linux, DNS server settings are +global. The settings can either be statically set or supplied by a DHCP +server. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dns_suffix_list (list of str or None) – List of name resolution suffixes for the virtual network adapter. +This list applies to both Windows and Linux guest customization. +For Linux, this setting is global, whereas in Windows, this setting +is listed on a per-adapter basis. This attribute was added in +vSphere API 7.0.0.0. +If None, no DNS suffixes are set.

    • +

  • dns_servers (list of str or None) – List of DNS servers, for a virtual network adapter with a static IP +address. If this list is empty, then the guest operating system is +expected to use a DHCP server to get its DNS server settings. These +settings configure the virtual machine to use the specified DNS +servers. These DNS server settings are listed in the order of +preference. This attribute was added in vSphere API 7.0.0.0. +If None, no DNS servers are set.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.GuiUnattended(auto_logon=None, auto_logon_count=None, password=None, time_zone=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The GuiUnattended class maps to the GuiUnattended key in the +sysprep.xml answer file. These values are plugged directly into the +sysprep.xml file that VirtualCenter stores on the target virtual disk. For +more detailed information about performing unattended installations, check +https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auto_logon (bool) – Flag to determine whether or not the machine automatically logs on +as Administrator. See the GuiUnattended.password property. +If GuiUnattended.auto_logon flag is set, then +GuiUnattended.password must not be None or the guest +customization will fail. This attribute was added in vSphere API +7.0.0.0.

    • +

  • auto_logon_count (long) – If the GuiUnattended.auto_logon flag is set, then +this property specifies the number of times the machine should +automatically log on as Administrator. Generally it should be 1, +but if the setup requires a number of reboots, you may want to +increase it. This number may be determined by the list of commands. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • password (str or None) – The new administrator password for the machine. To specify that the +password should be set to blank (that is, no password), leave it +unset. This attribute was added in vSphere API 7.0.0.0. +If None, blank password will be used.

    • +

  • time_zone (long) – The time zone index for the virtual machine. Numbers correspond to +time zones at +https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values. +This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.HostnameGenerator(type=None, fixed_name=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostnameGenerator class specifies various mechanisms of generating +the hostname for the guest inside the virtual machine while customization. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (HostnameGenerator.Type) – The type of the Name Generator. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • fixed_name (str) – The virtual machine name specified by the client. This attribute +was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is HostnameGenerator.Type.FIXED.

    • +

  • prefix (str) – Base prefix, to which a unique number is appended. This attribute +was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is HostnameGenerator.Type.PREFIX.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The HostnameGenerator.Type class specifies different types of Name +Generators. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+FIXED = Type(string='FIXED')
+

Specifies that a fixed name should be used for the hostname for the virtual +machine during the customization. This class attribute was added in vSphere +API 7.0.0.0.

+
+ +
+
+PREFIX = Type(string='PREFIX')
+

Specifies that a unique name should be generated by concatenating the base +string with a number including the network name of the guest.

+

Virtual machine names are unique across the set of hosts and virtual +machines known to the VirtualCenter instance. VirtualCenter tracks the +network names of virtual machines as well as hosts. VMware Tools runs in a +guest operating system and reports information to VirtualCenter.. This +class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+USER_INPUT_REQUIRED = Type(string='USER_INPUT_REQUIRED')
+

Indicates that the host name is not specified in advance. The user must +provide a valid value when the actual customization spec is applied to a +virtual machine. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+VIRTUAL_MACHINE = Type(string='VIRTUAL_MACHINE')
+

Specifies that the VirtualCenter should generate a virtual machine name.

+

The name is generated from a base prefix comprising the virtual machine +entity name. A number is appended, if necessary, to make it unique.

+

Virtual machine names are unique across the set of hosts and virtual +machines known to the VirtualCenter instance. VirtualCenter tracks the +network names of the virtual machines as well as hosts. VMware Tools runs +in a guest operating system and reports information to VirtualCenter, +including the network name of the guest.. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.IPSettings(ipv4=None, ipv6=None, windows=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IPSettings class specifies the IP settings for a virtual network +adapter. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ipv4 (Ipv4 or None) – Specification to configure IPv4 address, subnet mask and gateway +info for this virtual network adapter. This attribute was added in +vSphere API 7.0.0.0. +If None, no IPv4 addresses are set.

    • +

  • ipv6 (Ipv6 or None) – Specification to configure IPv6 address, subnet mask and gateway +info for this virtual network adapter. This attribute was added in +vSphere API 7.0.0.0. +If None, no IPv6 addresses are set.

    • +

  • windows (WindowsNetworkAdapterSettings or None) – Windows settings to be configured for this specific virtual Network +adapter. This is valid only for Windows guest operating systems. +This attribute was added in vSphere API 7.0.0.0. +If None, no specific Windows settings are set.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.Ipv4(type=None, ip_address=None, prefix=None, gateways=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv4 class specifies the IPv4 settings that need to be applied to a +virtual network adapter. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Ipv4.Type) – The type of the IPv4 configuration. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • ip_address (str) – The static IPv4 address. This attribute was added in vSphere API +7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Ipv4.Type.STATIC.

    • +

  • prefix (long) – The IPv4 CIDR prefix, for example, 24. See +http://www.oav.net/mirrors/cidr.html for netmask-to-prefix +conversion. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Ipv4.Type.STATIC.

    • +

  • gateways (list of str or None) – Gateways for the IPv4 address. This attribute was added in vSphere +API 7.0.0.0. +If None, no gateways are set.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ipv4.Type class specifies different types of the IPv4 +configuration. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DHCP = Type(string='DHCP')
+

DHCP configuration. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+STATIC = Type(string='STATIC')
+

Static configuration. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+USER_INPUT_REQUIRED = Type(string='USER_INPUT_REQUIRED')
+

Indicates that the IPv4 settings are not specified in advance. The user +must provide a valid value when the actual customization spec is applied to +a virtual machine. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.Ipv6(type=None, ipv6=None, gateways=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6 class specifies the IPv6 settings that need to be applied to a +virtual network adapter. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Ipv6.Type) – The IPv6 configuration type. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • ipv6 (list of Ipv6Address) – IPv6 address. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Ipv6.Type.STATIC.

    • +

  • gateways (list of str or None) – gateways for the IPv6 address. This attribute was added in vSphere +API 7.0.0.0. +If None, no gateways are set.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ipv6.Type class specifies different types of the IPv6 +configuration. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DHCP = Type(string='DHCP')
+

DHCP IPv6 configuration. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+STATIC = Type(string='STATIC')
+

Static IPv6 configuration. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+USER_INPUT_REQUIRED = Type(string='USER_INPUT_REQUIRED')
+

Indicates that the IPv6 settings are not specified in advance. The user +must provide a valid value when the actual customization spec is applied to +a virtual machine. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.Ipv6Address(ip_address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6Address class specifies the the settings for a Static IPv6 +configuration. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ip_address (str) – Static IPv6 Address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • prefix (long) – The CIDR prefix for the interface. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.LinuxConfiguration(hostname=None, domain=None, time_zone=None, script_text=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Guest customization Settings to customize a Linux guest operating system.

+

The LinuxConfiguration class contains settings that identify a Linux +machine in the same way that the WindowsConfiguration class +identifies a Windows machine.. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (HostnameGenerator) – The network host name of the Linux virtual machine. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • domain (str) – The fully qualified domain name. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • time_zone (str or None) –

    The case-sensitive time zone, such as Europe/Sofia. Valid time zone +values are based on the tz (time zone) database used by Linux. The +values are strings (str) in the form “Area/Location,” in +which Area is a continent or ocean name, and Location is the city, +island, or other regional designation.

    +

    See the https://kb.vmware.com/kb/2145518 for a list of supported +time zones for different versions in Linux.. This attribute was +added in vSphere API 7.0.0.0. +If None, time zone is not modified inside guest operating system.

    +

    • +

  • script_text (str or None) –

    The script to run before and after Linux guest customization. +The max size of the script is 65536 bytes. As long as the script +(shell, perl, python…) has the right “#!” in the header, it is +supported. The caller should not assume any environment variables +when the script is run.

    +

    The script is invoked by the customization engine using the command +line: 1) with argument “precustomization” before customization, 2) +with argument “postcustomization” after customization. The script +should parse this argument and implement pre-customization or +post-customization task code details in the corresponding block.

    +

    A Linux shell script example:

    +

    #!/bin/sh +if [ x$1 == x"precustomization" ]; then +echo "Do Precustomization tasks" +#code for pre-customization actions... +elif [ x$1 == x"postcustomization" ]; then +echo "Do Postcustomization tasks" +#code for post-customization actions... +fi. This attribute was added in vSphere API 7.0.0.0. +If None, no script will be executed.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.UserData(computer_name=None, full_name=None, organization=None, product_key=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UserData class specifies the personal data pertaining to the user +of the Windows guest operating system. This class maps to the UserData key +in the sysprep.xml answer file. These values are transferred directly into +the sysprep.xml file that VirtualCenter stores on the target virtual disk. +For more detailed information about performing unattended installation, +check https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • computer_name (HostnameGenerator) – The computer name of the (Windows) virtual machine. A computer name +may contain letters (A-Z), numbers(0-9) and hyphens (-) but no +spaces or periods (.). The name may not consist entirely of digits. +A computer name is restricted to 15 characters in length. If the +computer name is longer than 15 characters, it will be truncated to +15 characters. Check HostnameGenerator for various +options. This attribute was added in vSphere API 7.0.0.0.

    • +

  • full_name (str) – Full name of the end user. Note that this is not the username but +full name specified in “Firstname Lastname” format. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • organization (str) – Name of the organization that owns the computer. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • product_key (str) – The product Key to use for activating Windows guest operating +system. This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.guest_client.WindowsConfiguration(reboot=None, sysprep=None, sysprep_xml=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The WindowsConfiguration class specifies the settings for customizing a +windows guest operating system. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reboot (WindowsConfiguration.RebootOption or None) – A value specifying the action that should be taken after +customization. This attribute was added in vSphere API 7.0.0.0. +If None, the WindowsConfiguration.RebootOption.REBOOT +option will be chosen.

    • +

  • sysprep (WindowsSysprep or None) – Customization settings like user details, administrator details, +etc for the windows guest operating system. Exactly one of +sysprep or sysprepXml must be specified. This attribute was +added in vSphere API 7.0.0.0. +If None, sysprep settings will not be applied to the windows guest +operating system.

    • +

  • sysprep_xml (str or None) – All settings specified in a XML format. This is the content of a +typical answer.xml file that is used by System administrators +during the Windows image customization. Check +https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs +Exactly one of sysprep or sysprepXml must be specified. +This attribute was added in vSphere API 7.0.0.0. +If None, sysprep settings will not be applied to the windows guest +operating system.

    • +
+
+
+
+
+class RebootOption(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The WindowsConfiguration.RebootOption class specifies what should be +done to the guest after the customization. This enumeration was added in +vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the RebootOption instance.

+
+
+
+
+NO_REBOOT = RebootOption(string='NO_REBOOT')
+

Take no action. Leave the guest OS running after customization. This option +can be used to look at values for debugging purposes. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+REBOOT = RebootOption(string='REBOOT')
+

Reboot the guest after customization. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+SHUTDOWN = RebootOption(string='SHUTDOWN')
+

Shutdown the guest after customization. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings(dns_servers=None, dns_domain=None, wins_servers=None, net_bios_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The WindowsNetworkAdapterSettings class specifies Windows specific +Network settings for a virtual network adapter. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dns_servers (list of str or None) –

    A list of server IP addresses to use for DNS lookup in a Windows +guest operating system.

    +

    These servers should be specified in the order of preference. If +this list is not empty, and if a DHCP IP address is used, then +these settings override the DHCP settings.. This attribute was +added in vSphere API 7.0.0.0. +If None, no DNS servers are set.

    +

    • +

  • dns_domain (str or None) – A DNS domain suffix such as vmware.com. This attribute was added in +vSphere API 7.0.0.0. +If None, no DNS domain is set.

    • +

  • wins_servers (list of str or None) – List of WINS Servers to set for the Windows guest operating system. +A Maximum of two IP addresses can be specified in this list. The +first IP address will be set as the primary WINS server. The second +IP address will be set as the secondary WINS server. This attribute +was added in vSphere API 7.0.0.0. +If None, no WINS Servers are set.

    • +

  • net_bios_mode (WindowsNetworkAdapterSettings.NetBIOSMode or None) – NetBIOS setting for Windows. This attribute was added in vSphere +API 7.0.0.0. +If None, existing NetBIOS mode will be retained.

    • +
+
+
+
+
+class NetBIOSMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The WindowsNetworkAdapterSettings.NetBIOSMode class specifies different +NetBIOS settings for Windows guest operating systems. This enumeration was +added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetBIOSMode instance.

+
+
+
+
+DISABLE = NetBIOSMode(string='DISABLE')
+

Never use NetBIOS. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+ENABLE = NetBIOSMode(string='ENABLE')
+

Always use NetBIOS. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+USE_DHCP = NetBIOSMode(string='USE_DHCP')
+

DHCP server decides whether or not to use NetBIOS. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.guest_client.WindowsSysprep(gui_run_once_commands=None, user_data=None, domain=None, gui_unattended=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The WindowsSysprep class provides all the settings like user details, +administrator details, etc that need to applied for a windows guest +operating system during customization. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • gui_run_once_commands (list of str or None) – A list of commands to run at first user logon, after customizing +the guest. These commands are directly mapped to the GuiRunOnce key +in the sysprep.xml answer file. These commands are transferred into +the sysprep.xml file that VirtualCenter stores on the target +virtual disk. For more information about performing unattended +installation, check +https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx +The commands listed here ar executed when a user logs on the first +time after customization completes. The logon may be driven by +GuiUnattended.auto_logon setting. These commands are +directly mapped to the GuiRunOnce key in the. This attribute was +added in vSphere API 7.0.0.0. +If None, no commands are run.

    • +

  • user_data (UserData) – Personal data pertaining to the owner of the virtual machine. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • domain (Domain or None) – Information needed to join a workgroup or domain. This attribute +was added in vSphere API 7.0.0.0. +If None, the guest will not be joined to any workgroup or a domain.

    • +

  • gui_unattended (GuiUnattended) – Information related to unattended installation. This attribute was +added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+

com.vmware.vcenter.host_client module

+
+
+class com.vmware.vcenter.host_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.hvc_client module

+

The com.vmware.vcenter.hvc_client module provides classes to manage hybrid +links between a local and remote Platform Service Controller. Usage beyond +VMware Cloud on AWS is not supported.

+
+ +

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Links class provides methods to create, delete, get information, +and list hybrid links between the local and foreign Platform Service +Controller (PSC). Usage beyond VMware Cloud on AWS is not supported.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CertificateInfo(ssl_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Links.CertificateInfo class contains information about the SSL +certificate for a destination PSC endpoint.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ssl_thumbprint (str) – The SHA-256 thumbprint of the SSL certificate for the destination +PSC endpoint.

+
+
+
+ +
+
+class CreateSpec(psc_hostname=None, port=None, domain_name=None, username=None, password=None, ssl_thumbprint=None, admin_groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Links.CreateSpec class is the specification used for the hybrid +link creation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • psc_hostname (str) – The PSC hostname for the domain to be linked.

    • +

  • port (str or None) – The HTTPS port of the PSC to be linked. +If None 443 will be used as default.

    • +

  • domain_name (str) – The domain to which the PSC belongs.

    • +

  • username (str) – The administrator username of the PSC.

    • +

  • password (str) – The administrator password of the PSC.

    • +

  • ssl_thumbprint (str or None) – The ssl thumbprint of the server. +if None no thumbprint is passed.

    • +

  • admin_groups (set of str or None) – List of groups to be added to enable administrator access to. +if None administrator access will not be set.

    • +
+
+
+
+ +
+
+class Credentials(user_name=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Links.Credentials class specifies user credentials to make a +successful connection to remote endpoint

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • user_name (str) – Name of the user to authenticate

    • +

  • password (str) – Password for the user.

    • +
+
+
+
+ +
+
+class Info(connection_health_status=None, health_status_message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Links.Info class contains information about link.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class HealthStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Links.Info.HealthStatus class defines the possible states for +health of a link.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HealthStatus instance.

+
+
+
+
+HEALTHY = HealthStatus(string='HEALTHY')
+

Connection is healthy

+
+ +
+
+UNHEALTHY = HealthStatus(string='UNHEALTHY')
+

Connection issues will need to be remediated

+
+ +
+ +
+ +
+
+class Summary(link=None, display_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Links.Summary class contains information about the hybrid link.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • link (str) – Unique identifier for the link. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.hvc.Links. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.hvc.Links.

    • +

  • display_name (str) – The display name is set to the domain name which was set during +create.

    • +
+
+
+
+ +
+
+create(spec)
+

Creates a new hybrid link between the local and foreign PSC. Usage +beyond VMware Cloud on AWS is not supported.

+
+
Parameters
+

spec (Links.CreateSpec) – Specification for the new link to be created.

+
+
Return type
+

str

+
+
Returns
+

The identifier of the newly linked domain. +The return value will be an identifier for the resource type: +com.vmware.vcenter.hvc.Links.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If the link already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the values of any of the attributes of the spec parameter +are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +If the PSC or the VC version is not supported.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the foreign PSC cannot be validated by +comparing with the thumbprint provided in +Links.CreateSpec.ssl_thumbprint or if +Links.CreateSpec.ssl_thumbprint is None. The value of the +{\@link UnverifiedPeer#data) attribute will be a class that +contains all the attributes defined in +Links.CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+
+delete(link)
+

Deletes an existing hybrid link. This API should be used when unlink is +initiated from Cloud Gateway.

+
+
Parameters
+

link (str) – Identifier of the hybrid link. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.hvc.Links.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the hybrid link associated with link does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+
+delete_with_credentials(link, credentials=None)
+

Deletes an existing hybrid link. This API should be used when unlink is +initiated from cloud vCenter. Usage beyond VMware Cloud on AWS is not +supported.

+
+
Parameters
+
    +

  • link (str) – Identifier of the hybrid link. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.hvc.Links.

    • +

  • credentials (Links.Credentials or None) – Credentials to use for authentication to the remote system. +This parameter is currently required. In the future, it may become +optional.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the hybrid link associated with link does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+
+get(link)
+

Gets information for a link. Usage beyond VMware Cloud on AWS is not +supported.

+
+
Parameters
+

link (str) – Unique identifier of the link. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.hvc.Links.

+
+
Return type
+

Links.Info

+
+
Returns
+

Information about the link.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the hybrid link associated with link does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is not authorized to perform this operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the service is busy.

+
+
+
+ +
+
+list()
+

Enumerates the list of registered hybrid links. Usage beyond VMware +Cloud on AWS is not supported.

+
+
Return type
+

list of Links.Summary

+
+
Returns
+

The list of hybrid link information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.hvc_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.identity_client module

+

The com.vmware.vcenter.identity_client module provides classes to manage +VcIdentity.

+
+
+class com.vmware.vcenter.identity_client.FederationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The FederationType class contains the possible types of federation +paths for, vCenter Server identity providers configuration. This +enumeration was added in vSphere API 8.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the FederationType instance.

+
+
+
+
+DIRECT_FEDERATION = FederationType(string='DIRECT_FEDERATION')
+

vCenter Server federated directly to the external identity provider. This +class attribute was added in vSphere API 8.0.1.0.

+
+ +
+
+INDIRECT_FEDERATION = FederationType(string='INDIRECT_FEDERATION')
+

vCenter Server federated indirectly to the external identity provider, by +means of an intermediary federation broker. This class attribute was added +in vSphere API 8.0.1.0.

+
+ +
+ +
+
+class com.vmware.vcenter.identity_client.Providers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Providers interface provides methods to list, read and modify +vCenter Server identity providers. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ActiveDirectoryOverLdap(user_name=None, password=None, users_base_dn=None, groups_base_dn=None, server_endpoints=None, cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ActiveDirectoryOverLdap class contains the information +about to how to use an Active Directory over LDAP connection to allow +searching for users and groups if the identity provider is an On-Prem +service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • user_name (str) – User name to connect to the active directory server. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • password (str) – Password to connect to the active directory server. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • users_base_dn (str) – Base distinguished name for users. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • groups_base_dn (str) – Base distinguished name for groups. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • server_endpoints (list of str) – Active directory server endpoints. At least one active directory +server endpoint must be set. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • cert_chain (com.vmware.vcenter.certificate_management_client.X509CertChain or None) – SSL certificate chain in base64 encoding. This attribute was added +in vSphere API 7.0.0.0. +This attribute can be None only, if all the active directory server +endpoints use the LDAP (not LDAPS) protocol.

    • +
+
+
+
+ +
+
+class ConfigType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.ConfigType class contains the possible types of vCenter +Server identity providers. This enumeration was added in vSphere API +7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigType instance.

+
+
+
+
+Oauth2 = ConfigType(string='Oauth2')
+

Config for OAuth2. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+Oidc = ConfigType(string='Oidc')
+

Config for OIDC. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class CreateSpec(config_tag=None, oauth2=None, oidc=None, org_ids=None, is_default=None, name=None, domain_names=None, auth_query_params=None, idm_protocol=None, idm_endpoints=None, active_directory_over_ldap=None, upn_claim=None, groups_claim=None, federation_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.CreateSpec class contains the information used to create +an identity provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config_tag (Providers.ConfigType) – The config type of the identity provider. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • oauth2 (Providers.Oauth2CreateSpec) – OAuth2 CreateSpec. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oauth2.

    • +

  • oidc (Providers.OidcCreateSpec) – OIDC CreateSpec. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oidc.

    • +

  • org_ids (set of str or None) – The set of orgIds as part of SDDC creation which provides the basis +for tenancy. This attribute was added in vSphere API 7.0.0.0. +If None, the set will be empty.

    • +

  • is_default (bool or None) – Specifies whether the provider is the default provider. Setting +isDefault of current provider to True makes all other providers +non-default. If no other providers created in this vCenter Server +before, this parameter will be disregarded, and the provider will +always be set to the default. This attribute was added in vSphere +API 7.0.0.0. +If None the provider will be the default provider if it is the +first provider that is created, and will not be the default +provider otherwise.

    • +

  • name (str or None) – The user friendly name for the provider. This name can be used for +human-readable identification purposes, but it does not have to be +unique, as the system will use internal UUIDs to differentiate +providers. This attribute was added in vSphere API 7.0.0.0. +If None, the name will be the empty string

    • +

  • domain_names (set of str or None) – Set of fully qualified domain names to trust when federating with +this identity provider. Tokens from this identity provider will +only be validated if the user belongs to one of these domains, and +any domain-qualified groups in the tokens will be filtered to +include only those groups that belong to one of these domains. This +attribute was added in vSphere API 7.0.0.0. +If None, domainNames will be the empty set and the domain +validation behavior at login with this identity provider will be as +follows: the user’s domain will be parsed from the User Principal +Name (UPN) value that is found in the tokens returned by the +identity provider. This domain will then be implicitly trusted and +used to filter any groups that are also provided in the tokens.

    • +

  • auth_query_params ((dict of str and list of str) or None) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, the map will be empty.

    +

    • +

  • idm_protocol (Providers.IdmProtocol or None) – Communication protocol to the identity management endpoints. This +attribute was added in vSphere API 7.0.0.0. +If None, no communication protocol will be configured for the +identity provider.

    • +

  • idm_endpoints (list of str) – Identity management endpoints. When specified, at least one +endpoint must be provided. This attribute was added in vSphere API +7.0.0.0. +This attribute is optional and it is only relevant when the value +of idmProtocol is one of Providers.IdmProtocol.REST, +Providers.IdmProtocol.SCIM, or +Providers.IdmProtocol.SCIM2_0.

    • +

  • active_directory_over_ldap (Providers.ActiveDirectoryOverLdap) – Identity management configuration. If the protocol is LDAP, the +configuration must be set, else InvalidArgument is thrown. This +attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of idmProtocol is Providers.IdmProtocol.LDAP.

    • +

  • upn_claim (str or None) – Specifies which claim provides the user principal name (UPN) for +the user. This attribute was added in vSphere API 7.0.0.0. +If None, the claim named ‘acct’ will be used to provide backwards +compatibility with CSP.

    • +

  • groups_claim (str or None) – Specifies which claim provides the group membership for the token +subject. These groups will be used for mapping to local groups per +the claim map. This attribute was added in vSphere API 7.0.0.0. +If None, the default behavior will be CSP backwards compatiblility. +The groups for the subject will be comprised of the groups in +‘group_names’ and ‘group_ids’ claims.

    • +

  • federation_type (FederationType or None) – The type of the identity provider. This attribute was added in +vSphere API 8.0.1.0. +If None, the federation type value will not be set.

    • +
+
+
+
+ +
+
+class IdmProtocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.IdmProtocol class contains the possible types of +communication protocols to the identity management endpoints. This +enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IdmProtocol instance.

+
+
+
+
+LDAP = IdmProtocol(string='LDAP')
+

LDAP protocol based identity management endpoints. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+REST = IdmProtocol(string='REST')
+

REST protocol based identity management endpoints. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+SCIM = IdmProtocol(string='SCIM')
+

SCIM V1.1 protocol based identity management endpoints. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SCIM2_0 = IdmProtocol(string='SCIM2_0')
+

SCIM V2.0 protocol based identity management endpoints. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(name=None, org_ids=None, config_tag=None, oauth2=None, oidc=None, is_default=None, domain_names=None, auth_query_params=None, idm_protocol=None, idm_endpoints=None, active_directory_over_ldap=None, upn_claim=None, groups_claim=None, federation_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Info class contains the information about an identity +provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The user friendly name for the provider. This attribute was added +in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • org_ids (set of str) – The set of orgIds as part of SDDC creation which provides the basis +for tenancy. This attribute was added in vSphere API 7.0.0.0.

    • +

  • config_tag (Providers.ConfigType) – The config type of the identity provider. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • oauth2 (Providers.Oauth2Info) – OAuth2 Info. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oauth2.

    • +

  • oidc (Providers.OidcInfo) – OIDC Info. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oidc.

    • +

  • is_default (bool) – Specifies whether the provider is the default provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • domain_names (set of str) – Set of fully qualified domain names to trust when federating with +this identity provider. Tokens from this identity provider will +only be validated if the user belongs to one of these domains, and +any domain-qualified groups in the tokens will be filtered to +include only those groups that belong to one of these domains. If +domainNames is an empty set, domain validation behavior at login +with this identity provider will be as follows: the user’s domain +will be parsed from the User Principal Name (UPN) value that is +found in the tokens returned by the identity provider. This domain +will then be implicitly trusted and used to filter any groups that +are also provided in the tokens. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • auth_query_params (dict of str and list of str) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    +

    • +

  • idm_protocol (Providers.IdmProtocol or None) – Communication protocol to the identity management endpoints. This +attribute was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • idm_endpoints (list of str) – Identity management endpoints. This attribute was added in vSphere +API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of idmProtocol is one of Providers.IdmProtocol.REST, +Providers.IdmProtocol.SCIM, or +Providers.IdmProtocol.SCIM2_0.

    • +

  • active_directory_over_ldap (Providers.ActiveDirectoryOverLdap) – Identity management configuration. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of idmProtocol is Providers.IdmProtocol.LDAP.

    • +

  • upn_claim (str) – Specifies which claim provides the user principal name (UPN) for +the user. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • groups_claim (str) – Specifies which claim provides the group membership for the token +subject. If empty, the default behavior for CSP is used. In this +case, the groups for the subject will be comprised of the groups in +‘group_names’ and ‘group_ids’ claims. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • federation_type (FederationType or None) – The type of the identity provider. This attribute was added in +vSphere API 8.0.1.0. +If no federation type value set earlier.

    • +
+
+
+
+ +
+
+class Oauth2AuthenticationMethod(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.Oauth2AuthenticationMethod class contains the possible +types of OAuth2 authentication methods. This enumeration was added in +vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Oauth2AuthenticationMethod instance.

+
+
+
+
+CLIENT_SECRET_BASIC = Oauth2AuthenticationMethod(string='CLIENT_SECRET_BASIC')
+

Clients that have received a client_secret value from the Authorization +Server, authenticate with the Authorization Server in accordance with +Section 3.2.1 of OAuth 2.0 [RFC6749] using the HTTP Basic authentication +scheme. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+CLIENT_SECRET_JWT = Oauth2AuthenticationMethod(string='CLIENT_SECRET_JWT')
+

Clients that have received a client_secret value from the Authorization +Server, create a JWT using an HMAC SHA algorithm, such as HMAC SHA-256. The +HMAC (Hash-based Message Authentication Code) is calculated using the +octets of the UTF-8 representation of the client_secret as the shared key. +This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+CLIENT_SECRET_POST = Oauth2AuthenticationMethod(string='CLIENT_SECRET_POST')
+

Clients that have received a client_secret value from the Authorization +Server, authenticate with the Authorization Server in accordance with +Section 3.2.1 of OAuth 2.0 [RFC6749] by including the Client Credentials in +the request body. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+PRIVATE_KEY_JWT = Oauth2AuthenticationMethod(string='PRIVATE_KEY_JWT')
+

Clients that have registered a public key sign a JWT using that key. The +client authenticates in accordance with JSON Web Token (JWT) Profile for +OAuth 2.0 Client Authentication and Authorization Grants [OAuth.JWT] and +Assertion Framework for OAuth 2.0 Client Authentication and Authorization +Grants [OAuth.Assertions]. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+ +
+
+class Oauth2CreateSpec(auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Oauth2CreateSpec class contains the information used to +create an OAuth2 identity provider. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auth_endpoint (str) – Authentication/authorization endpoint of the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • token_endpoint (str) – Token endpoint of the provider. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • public_key_uri (str) – Endpoint to retrieve the provider public key for validation. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • client_id (str) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • client_secret (str) – The secret shared between the client and the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim +that vCenter Server understands. Currently only the key “perms” is +supported. The key “perms” is used for mapping the “perms” claim of +incoming JWT. The value is another map with an external group as +the key and a vCenter Server group as value. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • issuer (str) – The identity provider namespace. It is used to validate the issuer +in the acquired OAuth2 token. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • authentication_method (Providers.Oauth2AuthenticationMethod) – Authentication method used by the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • auth_query_params ((dict of str and list of str) or None) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, the map will be empty.

    +

    • +
+
+
+
+ +
+
+class Oauth2Info(auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Oauth2Info class contains the information about an OAuth2 +identity provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auth_endpoint (str) – Authentication/authorization endpoint of the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • token_endpoint (str) – Token endpoint of the provider. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • public_key_uri (str) – Endpoint to retrieve the provider public key for validation. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • client_id (str) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • client_secret (str) – The secret shared between the client and the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim +that vCenter Server understands. Currently only the key “perms” is +supported. The key “perms” is used for mapping the “perms” claim of +incoming JWT. The value is another map with an external group as +the key and a vCenter Server group as value. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • issuer (str) – The identity provider namespace. It is used to validate the issuer +in the acquired OAuth2 token. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • authentication_method (Providers.Oauth2AuthenticationMethod) – Authentication method used by the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • auth_query_params (dict of str and list of str) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+class Oauth2Summary(auth_endpoint=None, token_endpoint=None, client_id=None, authentication_header=None, auth_query_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Oauth2Summary class contains commonly used information +about an OAuth2 identity provider. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auth_endpoint (str) – Authentication/authorization endpoint of the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • token_endpoint (str) – Token endpoint of the provider. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • client_id (str) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • authentication_header (str) – The authentication data used as part of request header to acquire +or refresh an OAuth2 token. The data format depends on the +authentication method used. Example of basic authentication format: +Authorization: Basic [base64Encode(clientId + “:” + secret)]. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • auth_query_params (dict of str and list of str) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+class Oauth2UpdateSpec(auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Oauth2UpdateSpec class contains the information used to +update the OAuth2 identity provider. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auth_endpoint (str or None) – Authentication/authorization endpoint of the provider. This +attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • token_endpoint (str or None) – Token endpoint of the provider. This attribute was added in vSphere +API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • public_key_uri (str or None) – Endpoint to retrieve the provider public key for validation. This +attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • client_id (str or None) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • client_secret (str or None) – Shared secret between identity provider and client. This attribute +was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • claim_map ((dict of str and (dict of str and list of str)) or None) – The map used to transform an OAuth2 claim to a corresponding claim +that vCenter Server understands. Currently only the key “perms” is +supported. The key “perms” is used for mapping the “perms” claim of +incoming JWT. The value is another map with an external group as +the key and a vCenter Server group as value. This attribute was +added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • issuer (str or None) – The identity provider namespace. It is used to validate the issuer +in the acquired OAuth2 token. This attribute was added in vSphere +API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • authentication_method (Providers.Oauth2AuthenticationMethod or None) – Authentication method used by the provider. This attribute was +added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • auth_query_params ((dict of str and list of str) or None) – key/value pairs that are to be appended to the authEndpoint +request. How to append to authEndpoint request: If the map is not +empty, a “?” is added to the endpoint URL, and combination of each +k and each string in the v is added with an “&” delimiter. Details: +If the value contains only one string, then the key is added with +“k=v”. If the value is an empty list, then the key is added without +a “=v”. If the value contains multiple strings, then the key is +repeated in the query-string for each string in the value. If the +map is empty, deletes all params. This attribute was added in +vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +
+
+
+
+ +
+
+class OidcCreateSpec(discovery_endpoint=None, client_id=None, client_secret=None, claim_map=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.OidcCreateSpec class contains the information used to +create an OIDC identity provider. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • discovery_endpoint (str) – Endpoint to retrieve the provider metadata. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • client_id (str) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • client_secret (str) – The secret shared between the client and the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim +that vCenter Server understands. Currently only the key “perms” is +supported. The key “perms” is used for mapping the “perms” claim of +incoming JWT. The value is another map with an external group as +the key and a vCenter Server group as value. This attribute was +added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class OidcInfo(discovery_endpoint=None, logout_endpoint=None, auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.OidcInfo class contains information about an OIDC +identity provider. OIDC is a discovery protocol for OAuth2 configuration +metadata, so Providers.OidcInfo contains additional discovered OAuth2 +metadata. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • discovery_endpoint (str) – Endpoint to retrieve the provider metadata. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • logout_endpoint (str) – The endpoint to use for terminating the user’s session at the +identity provider. This value is automatically derived from the +metadata information provided by the OIDC discovery endpoint. This +attribute was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • auth_endpoint (str) – Authentication/authorization endpoint of the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • token_endpoint (str) – Token endpoint of the provider. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • public_key_uri (str) – Endpoint to retrieve the provider public key for validation. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • client_id (str) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • client_secret (str) – The secret shared between the client and the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim +that vCenter Server understands. Currently only the key “perms” is +supported. The key “perms” is used for mapping the “perms” claim of +incoming JWT. The value is another map with an external group as +the key and a vCenter Server group as value. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • issuer (str) – The identity provider namespace. It is used to validate the issuer +in the acquired OAuth2 token. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • authentication_method (Providers.Oauth2AuthenticationMethod) – Authentication method used by the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • auth_query_params (dict of str and list of str) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+class OidcSummary(discovery_endpoint=None, logout_endpoint=None, auth_endpoint=None, token_endpoint=None, client_id=None, authentication_header=None, auth_query_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.OidcSummary class contains commonly used information +about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 +configuration metadata, so Providers.OidcSummary contains discovered +OAuth2 metadata. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • discovery_endpoint (str) – Endpoint to retrieve the provider metadata. This attribute was +added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • logout_endpoint (str) – The endpoint to use for terminating the user’s session at the +identity provider. This value is automatically derived from the +metadata information provided by the OIDC discovery endpoint. This +attribute was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • auth_endpoint (str) – Authentication/authorization endpoint of the provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • token_endpoint (str) – Token endpoint of the provider. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • client_id (str) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • authentication_header (str) – The authentication data used as part of request header to acquire +or refresh an OAuth2 token. The data format depends on the +authentication method used. Example of basic authentication format: +Authorization: Basic [base64Encode(clientId + “:” + secret)]. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • auth_query_params (dict of str and list of str) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+class OidcUpdateSpec(discovery_endpoint=None, client_id=None, client_secret=None, claim_map=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.OidcUpdateSpec class contains the information used to +update the OIDC identity provider. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • discovery_endpoint (str or None) – Endpoint to retrieve the provider metadata. This attribute was +added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • client_id (str or None) – Client identifier to connect to the provider. This attribute was +added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • client_secret (str or None) – The secret shared between the client and the provider. This +attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • claim_map ((dict of str and (dict of str and list of str)) or None) – The map used to transform an OAuth2 claim to a corresponding claim +that vCenter Server understands. Currently only the key “perms” is +supported. The key “perms” is used for mapping the “perms” claim of +incoming JWT. The value is another map with an external group as +the key and a vCenter Server group as value. This attribute was +added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +
+
+
+
+ +
+
+class Summary(provider=None, name=None, config_tag=None, oauth2=None, oidc=None, is_default=None, domain_names=None, auth_query_params=None, federation_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Summary class contains commonly used information about an +identity provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – The identifier of the provider. This attribute was added in vSphere +API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.identity.Providers. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.identity.Providers.

    • +

  • name (str) – The user friendly name for the provider. This attribute was added +in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • config_tag (Providers.ConfigType) – The config type of the identity provider. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • oauth2 (Providers.Oauth2Summary) – OAuth2 Summary. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oauth2.

    • +

  • oidc (Providers.OidcSummary) – OIDC Summary. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oidc.

    • +

  • is_default (bool) – Specifies whether the provider is the default provider. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • domain_names (set of str) – Set of fully qualified domain names to trust when federating with +this identity provider. Tokens from this identity provider will +only be validated if the user belongs to one of these domains, and +any domain-qualified groups in the tokens will be filtered to +include only those groups that belong to one of these domains. If +domainNames is an empty set, domain validation behavior at login +with this identity provider will be as follows: the user’s domain +will be parsed from the User Principal Name (UPN) value that is +found in the tokens returned by the identity provider. This domain +will then be implicitly trusted and used to filter any groups that +are also provided in the tokens. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • auth_query_params (dict of str and list of str) –

    key/value pairs that are to be appended to the authEndpoint +request.

    +

    How to append to authEndpoint request: If the map is not empty, a +“?” is added to the endpoint URL, and combination of each k and +each string in the v is added with an “&” delimiter. Details:

    +
      +

    • If the value contains only one string, then the key is added with +“k=v”.

      • +

    • If the value is an empty list, then the key is added without a +“=v”.

      • +

    • If the value contains multiple strings, then the key is repeated +in the query-string for each string in the value.

      • +
    +

    . This attribute was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    +

    • +

  • federation_type (FederationType or None) – The type of the identity provider. This attribute was added in +vSphere API 8.0.1.0. +If no federation type value set earlier.

    • +
+
+
+
+ +
+
+class UpdateSpec(config_tag=None, oauth2=None, oidc=None, org_ids=None, make_default=None, name=None, domain_names=None, auth_query_params=None, idm_protocol=None, idm_endpoints=None, active_directory_over_ldap=None, upn_claim=None, reset_upn_claim=None, groups_claim=None, reset_groups_claim=None, federation_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.UpdateSpec class contains the information used to update +the identity provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config_tag (Providers.ConfigType) – The config type of the identity provider. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • oauth2 (Providers.Oauth2UpdateSpec) – OAuth2 UpdateSpec. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oauth2.

    • +

  • oidc (Providers.OidcUpdateSpec) – OIDC UpdateSpec. This attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of configTag is Providers.ConfigType.Oidc.

    • +

  • org_ids (set of str or None) – The set orgIds as part of SDDC creation which provides the basis +for tenancy. This attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • make_default (bool or None) – Specifies whether to make this the default provider. If +makeDefault is set to true, this provider will be flagged as +the default provider and any other providers that had previously +been flagged as the default will be made non-default. If +makeDefault is set to false, this provider’s default flag will +not be modified. This attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • name (str or None) – The user friendly name for the provider. This name can be used for +human-readable identification purposes, but it does not have to be +unique, as the system will use internal UUIDs to differentiate +providers. This attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • domain_names (set of str or None) – Set of fully qualified domain names to trust when federating with +this identity provider. Tokens from this identity provider will +only be validated if the user belongs to one of these domains, and +any domain-qualified groups in the tokens will be filtered to +include only those groups that belong to one of these domains. This +attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged. If domainNames is an empty set, +domain validation behavior at login with this identity provider +will be as follows: the user’s domain will be parsed from the User +Principal Name (UPN) value that is found in the tokens returned by +the identity provider. This domain will then be implicitly trusted +and used to filter any groups that are also provided in the tokens.

    • +

  • auth_query_params ((dict of str and list of str) or None) – key/value pairs that are to be appended to the authEndpoint +request. How to append to authEndpoint request: If the map is not +empty, a “?” is added to the endpoint URL, and combination of each +k and each string in the v is added with an “&” delimiter. Details: +If the value contains only one string, then the key is added with +“k=v”. If the value is an empty list, then the key is added without +a “=v”. If the value contains multiple strings, then the key is +repeated in the query-string for each string in the value. If the +map is empty, deletes all params. This attribute was added in +vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • idm_protocol (Providers.IdmProtocol or None) – The protocol to communicate to the identity management endpoints. +This attribute was added in vSphere API 7.0.0.0. +If None, leave value unchanged.

    • +

  • idm_endpoints (list of str) – Identity management endpoints. When specified, at least one +endpoint must be provided. This attribute was added in vSphere API +7.0.0.0. +This attribute is optional and it is only relevant when the value +of idmProtocol is one of Providers.IdmProtocol.REST, +Providers.IdmProtocol.SCIM, or +Providers.IdmProtocol.SCIM2_0.

    • +

  • active_directory_over_ldap (Providers.ActiveDirectoryOverLdap) – Identity management configuration. If the protocol is LDAP, the +configuration must be set, else InvalidArgument is thrown. This +attribute was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of idmProtocol is Providers.IdmProtocol.LDAP.

    • +

  • upn_claim (str or None) – Specifies which claim provides the user principal name (UPN) for +the subject of the token. This attribute was added in vSphere API +7.0.0.0. +If None, leaves value unchanged.

    • +

  • reset_upn_claim (bool or None) – Flag indicating whether the user principal name (UPN) claim should +be set back to its default value. If this field is set to true, +the user principal name (UPN) claim will be set to ‘acct’, which is +used for backwards compatibility with CSP. If this field is set to +false, the existing user principal name (UPN) claim will be +changed to the value specified in +Providers.UpdateSpec.upn_claim, if any. This attribute was +added in vSphere API 7.0.0.0. +If None, the existing user principal name (UPN) claim will be +changed to the value specified in +Providers.UpdateSpec.upn_claim, if any.

    • +

  • groups_claim (str or None) – Specifies which claim provides the group membership for the token +subject. This attribute was added in vSphere API 7.0.0.0. +If None, leaves value unchanged.

    • +

  • reset_groups_claim (bool or None) – Flag indicating whether any existing groups claim value should be +removed. If this field is set to true, the existing groups +claim value is removed which defaults to backwards compatibility +with CSP. In this case, the groups for the subject will be +comprised of the groups in ‘group_names’ and ‘group_ids’ claims. If +this field is set to false, the existing groups claim will be +changed to the value specified in +Providers.UpdateSpec.groups_claim, if any. This attribute +was added in vSphere API 7.0.0.0. +If None, the existing groups claim will be changed to the value +specified in Providers.UpdateSpec.groups_claim, if any.

    • +

  • federation_type (FederationType or None) – The type of the identity provider. This attribute was added in +vSphere API 8.0.1.0. +If None, leaves value unchanged.

    • +
+
+
+
+ +
+
+create(spec)
+

Create a vCenter Server identity provider. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

spec (Providers.CreateSpec) – the CreateSpec contains the information used to create the provider

+
+
Return type
+

str

+
+
Returns
+

The identifier of the created identity provider. +The return value will be an identifier for the resource type: +com.vmware.vcenter.identity.Providers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if invalid arguments are provided in createSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if provider exists for provider ID in given spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Create and +VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+
+delete(provider)
+

Delete a vCenter Server identity provider. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

provider (str) – the identifier of the provider to delete +The parameter must be an identifier for the resource type: +com.vmware.vcenter.identity.Providers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no provider found with the given provider identifier.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+
+get(provider)
+

Retrieve detailed information of the specified identity provider. This +method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

provider (str) – the identifier of the provider +The parameter must be an identifier for the resource type: +com.vmware.vcenter.identity.Providers.

+
+
Return type
+

Providers.Info

+
+
Returns
+

Detailed information of the specified identity provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no provider found with the given provider identifier.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Read and +VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+
+list()
+

Retrieve all identity providers. This method was added in vSphere API +7.0.0.0.

+
+
Return type
+

list of Providers.Summary

+
+
Returns
+

Commonly used information about the identity providers.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Read and +VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+
+update(provider, spec)
+

Update a vCenter Server identity provider. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • provider (str) – the identifier of the provider to update +The parameter must be an identifier for the resource type: +com.vmware.vcenter.identity.Providers.

    • +

  • spec (Providers.UpdateSpec) – the UpdateSpec contains the information used to update the provider

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to caller.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if invalid arguments are provided in updateSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no provider found with the given provider identifier.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.identity_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.inventory_client module

+

The com.vmware.vcenter.inventory_client component provides methods and +classes for retrieving vCenter datastore and network information for a given +list of identifiers.

+
+
+class com.vmware.vcenter.inventory_client.Datastore(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Datastore class provides methods to retrieve information about +datastores.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Datastore.Info class contains information about a datastore.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (str) – Type of the datastore. +When clients pass a value of this class as a parameter, the +attribute must be one of Datastore or StoragePod. When +methods return a value of this class as a return value, the +attribute will be one of Datastore or StoragePod.

+
+
+
+ +
+
+find(datastores)
+

Returns datastore information for the specified datastores. The key in +the return value dict is the datastore identifier and the +value in the dict is the datastore information.

+
+
Parameters
+

datastores (list of str) – Identifiers of the datastores for which information will be +returned. +The parameter must contain identifiers for the resource type: +Datastore.

+
+
Return type
+

dict of str and (Datastore.Info or None)

+
+
Returns
+

Datastore information for the specified datastores. The key in the +return value dict is the datastore identifier and the +value in the dict is the datastore information. +The key in the return value dict will be an identifier for +the resource type: Datastore.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no datastore can be found for one or more of the datastore +identifiers in datastores

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource Datastore referenced by the parameter +datastores requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.inventory_client.Network(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Network class provides methods to retrieve information about +vCenter Server networks.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Network.Info class contains information about a vCenter Server +network.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (str) – Type of the vCenter Server network. +When clients pass a value of this class as a parameter, the +attribute must be one of Network, +DistributedVirtualPortgroup, or OpaqueNetwork. When methods +return a value of this class as a return value, the attribute will +be one of Network, DistributedVirtualPortgroup, or +OpaqueNetwork.

+
+
+
+ +
+
+find(networks)
+

Returns network information for the specified vCenter Server networks. +The key in the return value dict is the network identifier and +the value in the dict is the network information.

+
+
Parameters
+

networks (list of str) – Identifiers of the vCenter Server networks for which information +will be returned. +The parameter must contain identifiers for the resource type: +Network.

+
+
Return type
+

dict of str and (Network.Info or None)

+
+
Returns
+

Network information for the specified vCenter Server networks. The +key in the return value dict is the network identifier and +the value in the dict is the network information. +The key in the return value dict will be an identifier for +the resource type: Network.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no datastore can be found for one or more of the vCenter Server +network identifiers in networks

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource Network referenced by the parameter networks +requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.inventory_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.iso_client module

+

The com.vmware.vcenter.iso_client module provides classes and classes that +will let its client mount or unmount an ISO image on a virtual machine as a +CD-ROM.

+
+
+class com.vmware.vcenter.iso_client.Image(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Provides an interface to mount and unmount an ISO image on a virtual +machine.

+

This is an API that will let its client mount or unmount an ISO image on a +virtual machine as a CD-ROM.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+mount(library_item, vm)
+

Mounts an ISO image from a content library on a virtual machine.

+
+
Parameters
+
    +

  • library_item (str) – The identifier of the library item having the ISO image to mount on +the virtual machine. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • vm (str) – The identifier of the virtual machine where the specified ISO image +will be mounted. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +
+
+
Return type
+

str

+
+
Returns
+

The identifier of the newly created virtual CD-ROM backed by the +specified ISO image. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If either vm or the library_item is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If no .iso file is present on the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +When the operation is not allowed on the virtual machine in its +current state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Config.AddRemoveDevice.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter library_item requires +ContentLibrary.DownloadSession.

    • +
+
+
+
+ +
+
+unmount(vm, cdrom)
+

Unmounts a previously mounted CD-ROM using an ISO image as a backing.

+
+
Parameters
+
    +

  • vm (str) – The identifier of the virtual machine from which to unmount the +virtual CD-ROM. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • cdrom (str) – The device identifier of the CD-ROM. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the virtual machine identified by vm is not found or the +cdrom does not identify a virtual CD-ROM in the virtual +machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +When the operation is not allowed on the virtual machine in its +current state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Config.AddRemoveDevice.

    • +

  • The resource com.vmware.vcenter.vm.hardware.Cdrom referenced +by the parameter cdrom requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.iso_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.lcm_client module

+

The com.vmware.vcenter.lcm_client module provides classes for managing the +vCenter Server lifecycle. Copyright 2021 VMware, Inc. All rights reserved. – +VMware Confidential Copyright 2023 VMware, Inc. All rights reserved. – VMware +Confidential

+
+
+class com.vmware.vcenter.lcm_client.Notification(id=None, time=None, message=None, resolution=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notification class describes a notification that can be reported by +the appliance task, which can be of type info, warning or errors.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.vcenter.lcm_client.Notifications(info=None, warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Notifications class contains info/warning/error messages that can +be reported be the appliance task.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • info (list of Notification or None) – Info notification messages reported. +Only set if an info was reported by the appliance task.

    • +

  • warnings (list of Notification or None) – Warning notification messages reported. +Only set if an warning was reported by the appliance task.

    • +

  • errors (list of Notification or None) – Error notification messages reported. +Only set if an error was reported by the appliance task.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.lcm_client.Reports(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Report class provides an method to download the report generated by +the interop and precheck operations. To download a report, you must use the +get method. A Report.Location class represents the location of the +file which has Report.Token class which represents the token ID +(\@name String) and the expiration time of the token +Report.Token.expiry DateTime. Report.Location class also has the +URI for the file which needs to be downloaded.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Location(uri=None, download_file_token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Reports.Location class contains the URI location to download the +report from, as well as a token required (as a header on the HTTP request) +to get the bundle. The validity of the token is 5 minutes as best attempt. +After the token expires, any attempt to call the URI with said token will +fail.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • uri (str) – Report Download URI.

    • +

  • download_file_token (Reports.Token) – Information about the token required in the HTTP GET request to +retrieve the report

    • +
+
+
+
+ +
+
+class Token(token=None, expiry=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Reports.Token class contains information about the token required +in the HTTP GET request to generate the report.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • token (str) – A one-time, short-lived token required in the HTTP header of the +request to the url. This token needs to be passed in as a header +with the name “session-id”.

    • +

  • expiry (datetime.datetime) – Expiry time of the token

    • +
+
+
+
+ +
+
+get(report)
+

Returns the location Reports.Location information for +downloading the report for the specified file name.

+

Retrieving a report involves two steps:

+
    +

  • Step 1: Invoke the Reports.get() method to provision a token +and a URI.

    • +

  • Step 2: Make an HTTP GET request by using the URI and the token +returned in step 1 to retrieve the report.

    • +
+

The HTTP GET request will:

+
    +

  • Return 401 (Not Authorized) if the download URI is recognized, but +the token is invalid, 404 if the URL is not recognized otherwise return +200 (OK)

    • +

  • Provide the CSV contents as the output of the request. The API +accepts the file name as input, reads the contents of that CSV file, +and returns this text as the result of the API.

    • +
+
+
Parameters
+

report (str) – The parameter must be an identifier for the resource type: +com.vmware.vcenter.lcm.report.

+
+
Return type
+

Reports.Location

+
+
Returns
+

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no file associated with report in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.lcm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management_client module

+

The com.vmware.vcenter.namespace_management_client module provides classes +for managing Namespaces.

+
+
+class com.vmware.vcenter.namespace_management_client.CNSFileConfig(vsan_clusters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CNSFileConfig class contains the specification required to set the +configuration for Cloud Native Storage file volume support on Supervisor.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

vsan_clusters (list of str) –

CNSFileConfig.vsan_clusters is a list of clusters to be +used for provisioning file volumes.

+

As a prerequisite these clusters must have vSAN and vSAN file +services enabled, and must be in the same vCenter as the +Supervisor.

+

Currently this list must have a single entry which is the cluster +identifier of the current cluster. This cluster must be a vSAN +cluster and must have vSAN File Service enabled.

+

If a cluster in the list is not a vSAN cluster or does not have +vSAN File Service enabled, an InvalidArgument error will be thrown +from Clusters.enable(), Clusters.update() and +Clusters.set() APIs.

+

An empty list may be specified to disable file volume support on +the Supervisor. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource.

+

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The {\@name cluster-available-versions} class provides methods to +retrieve available upgrade versions of WCP and detailed information about +each upgrade.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Summary(version=None, name=None, description=None, release_date=None, release_notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterAvailableVersions.Summary class contains the information +about each available upgrade version.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Version of the upgrade.

    • +

  • name (str) – Name of the upgrade.

    • +

  • description (str) – Description of the upgrade.

    • +

  • release_date (datetime.datetime) – Release date of the upgrade.

    • +

  • release_notes (str) – Release details of the upgrade.

    • +
+
+
+
+ +
+
+list()
+

Get information about each available upgrade.

+
+
Return type
+

list of ClusterAvailableVersions.Summary

+
+
Returns
+

Information for each upgrade.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.ClusterCompatibility(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ClusterCompatibility class provides methods to get +Namespace-related compatibility information for clusters in this vCenter.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(compatible=None, network_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompatibility.FilterSpec class contains attributes used to +filter the results when listing clusters (see +ClusterCompatibility.list()) and their compatibility information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatible (bool or None) – Set this flag to true to only list vSphere clusters that are +currently compatible with the Namespaces feature. If set to false, +both compatible and incompatible vSphere clusters will be listed. +If None, both compatible and incompatible vSphere clusters will be +listed.

    • +

  • network_provider (Clusters.NetworkProvider or None) – The network provider whose networks will be considered. This +attribute was added in vSphere API 7.0.1.0. +If None, this will default to +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN.

    • +
+
+
+
+ +
+
+class FilterSpecV2(compatible=None, network_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompatibility.FilterSpecV2 class contains attributes used to +filter the results when listing clusters (see +ClusterCompatibility.list_v2()) and their compatibility information. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Summary(cluster=None, compatible=None, incompatibility_reasons=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompatibility.Summary class contains the information about +the compatibility of a vSphere cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier of the vSphere cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • compatible (bool) – Compatibility of this vSphere cluster. If false, the list of +incompatibility issues will be given in the +incompatibilityReasons field.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – Reasons for incompatibility.

    • +
+
+
+
+ +
+
+class ZoneCompatibilityInfo(compatible=None, zone_summaries=None, incompatibility_reasons=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompatibility.ZoneCompatibilityInfo class contains the +information about the compatibility between a list of vSphere Zones. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatible (bool) – Flag to indicate whether the vSphere Zones are compatible with each +other. If false, the list of incompatibility issues will be given +in the incompatibilityReasons field. This attribute was added +in vSphere API 8.0.0.1.

    • +

  • zone_summaries (list of ClusterCompatibility.ZoneSummary) – Information about the compatibility of a list of vSphere Zones and +the vSphere clusters associated with them. This attribute was added +in vSphere API 8.0.0.1.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – Reasons for incompatibility between the vSphere Zones. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class ZoneFilterSpec(zones=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompatibility.ZoneFilterSpec class contains attributes used +to filter the results when listing vSphere Zones (see +ClusterCompatibility.list_v2()) and their compatibility information. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

zones (list of str or None) – A list of vSphere Zone identifiers which will be used to filter +vSphere Zones that correspond to this specific set of identifiers. +This attribute was added in vSphere API 8.0.0.1. +If None or empty, results will not be filtered for specific vSphere +Zone identifiers.

+
+
+
+ +
+
+class ZoneSummary(zone=None, compatible=None, cluster_summaries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterCompatibility.ZoneSummary class contains the information +about the compatibility of a vSphere Zone and the vSphere clusters +associated with it. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str) – Identifier of this vSphere Zone. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • compatible (bool) – Flag to indicate whether the current Zone can be used to enable a +Supervisor cluster. If false, the list of incompatibility issues +will be given in the clusterSummaries field. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • cluster_summaries (list of ClusterCompatibility.Summary) – A list of information about the compatibility of vSphere clusters +associated with this vSphere Zone. This attribute was added in +vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns Namespaces compatibility information for all vSphere clusters +in the vCenter Server matching the +ClusterCompatibility.FilterSpec. The result contains only +visible (subject to permission checks) clusters.

+
+
Parameters
+

filter (ClusterCompatibility.FilterSpec or None) – Specification of matching clusters for which information should be +returned. +If None, the behavior is equivalent to a +ClusterCompatibility.FilterSpec with all attributes None +which means all NSX-T clusters the user is authorized to view will +be returned.

+
+
Return type
+

list of ClusterCompatibility.Summary

+
+
Returns
+

Namespaces compatibility information for the clusters matching the +the ClusterCompatibility.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if filter contains any error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege on the vSphere +clusters.

+
+
+
+ +
+
+list_v2(zone_filter=None, cluster_filter=None)
+

Returns Namespaces compatibility information for all vSphere clusters +that match the and are associated with the vSphere Zones in the +vCenter Server that match the . The result contains only visible +(subject to permission checks) clusters. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • zone_filter (ClusterCompatibility.ZoneFilterSpec or None) – Specification used to filter the results when listing vSphere +Zones. +If None, the behavior is equivalent to a with all attributes None +which means all available vSphere Zones will be returned.

    • +

  • cluster_filter (ClusterCompatibility.FilterSpecV2 or None) – Specification of matching vSphere clusters for which information +should be returned. +If None, the behavior is equivalent to a with all attributes None +which means all NSX-T clusters the user is authorized to view will +be returned.

    • +
+
+
Return type
+

ClusterCompatibility.ZoneCompatibilityInfo

+
+
Returns
+

Namespaces compatibility information for vSphere Zones that match +the and the vSphere clusters associated with them that match the .

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if zone_filter or cluster_filter contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege on the vSphere +clusters associated with the vSphere Zones.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.ClusterSizeInfo(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The {\@name cluster-size-info} class provides methods to retrieve +various sizes available for enabling Namespaces and information about each +size.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(num_supported_pods=None, num_supported_services=None, default_service_cidr=None, default_pod_cidr=None, master_vm_info=None, worker_vm_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSizeInfo.Info class contains the information about limits +associated with a SizingHint.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • num_supported_pods (long) – The maximum number of supported pods.

    • +

  • num_supported_services (long) – The maximum number of supported services.

    • +

  • default_service_cidr (Ipv4Cidr) – Default CIDR range from which Kubernetes allocates service cluster +IP addresses.

    • +

  • default_pod_cidr (Ipv4Cidr) – Default CIDR range from which Kubernetes allocates pod IP +addresses.

    • +

  • master_vm_info (ClusterSizeInfo.VmInfo) – Information about Kubernetes API server virtual machine +configuration.

    • +

  • worker_vm_info (ClusterSizeInfo.VmInfo or None) – Information about worker virtual machine configuration. +If None, the configuration of the worker VM is not fixed.

    • +
+
+
+
+ +
+
+class VmInfo(count=None, cores_per_socket=None, memory=None, capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSizeInfo.VmInfo class contains the information about the +configuration of the virtual machines which would be created for +Namespaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • count (long) – Number of CPU cores.

    • +

  • cores_per_socket (long) – Number of CPU cores per socket.

    • +

  • memory (long) – Memory size, in mebibytes.

    • +

  • capacity (long) – Overall capacity of the disks in the virtual machine, in mebibytes.

    • +
+
+
+
+ +
+
+get()
+

Get information about the default values associated with various sizes.

+
+
Return type
+

dict of SizingHint and ClusterSizeInfo.Info

+
+
Returns
+

Information for each size.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.Clusters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Clusters class provides methods to enable and disable vSphere +Namespaces on a vSphere cluster.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Condition(type=None, description=None, status=None, last_transition_time=None, reason=None, severity=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Condition class defines an observation of the +configuration state of a Supervisor. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (str) – The type of the condition is a CamelCase, machine readable +identifier, indicating the configuration stage. +InfrastructureInitialized, ControlPlaneVMsDeployed and +ControlPlaneVMsConfigured are examples of such identifiers. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the condition type in a human readable format. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • status (Clusters.Condition.Status) – The status of the condition. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • last_transition_time (datetime.datetime or None) – Last time the condition transitioned from one state to another. A +transition happens when the value of status or severity field +changes. This attribute was added in vSphere API 8.0.0.1. +if None, there are no ongoing operations related to bringing the +condition to the desired state.

    • +

  • reason (str) – A brief CamelCase message indicating details about the reason for +the last transition. FailedWithSystemError, +ManagementDNSServersMissing and WaitForNodeUpgrade are examples of +such messages. This attribute was added in vSphere API 8.0.0.1.

    • +

  • severity (Clusters.Condition.Severity) – Provides an explicit classification of the reason identifier. Set +when the value of status is FALSE. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • messages (list of Clusters.Message) – A list of human-readable messages that provide additional details +about the last transition. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+
+class Severity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.Condition.Severity class represents the severity of the +message. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Severity instance.

+
+
+
+
+ERROR = Severity(string='ERROR')
+

Error message. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+INFO = Severity(string='INFO')
+

Informational message. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+WARNING = Severity(string='WARNING')
+

Warning message. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Status of the condition, which can be one of TRUE, FALSE or UNKNOWN. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+FALSE = Status(string='FALSE')
+

Indicates that the condition has not reached the desired state. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+TRUE = Status(string='TRUE')
+

Indicates that the condition has reached the desired state. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+UNKNOWN = Status(string='UNKNOWN')
+

Indicates that the status of the condition can not be determined. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class ConfigStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.ConfigStatus class describes the status of reaching the +desired state configuration for the cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigStatus instance.

+
+
+
+
+CONFIGURING = ConfigStatus(string='CONFIGURING')
+

The Namespace configuration is being applied to the cluster.

+
+ +
+
+ERROR = ConfigStatus(string='ERROR')
+

Failed to apply the Namespace configuration to the cluster, user +intervention needed.

+
+ +
+
+REMOVING = ConfigStatus(string='REMOVING')
+

The Namespace configuration is being removed from the cluster.

+
+ +
+
+RUNNING = ConfigStatus(string='RUNNING')
+

The cluster is configured correctly with the Namespace configuration.

+
+ +
+ +
+
+class ContentLibrarySpec(content_library=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.ContentLibrarySpec class contains the specification +required to configure Content Libraries with a Supervisor. This class was +added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

content_library (str) – Content Library ID associated with a Supervisor. The Content +Library specified should exist in the vSphere inventory. This +attribute was added in vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

+
+
+
+ +
+
+class EnableSpec(size_hint=None, service_cidr=None, network_provider=None, ncp_cluster_network_spec=None, workload_networks_spec=None, workload_ntp_servers=None, load_balancer_config_spec=None, master_management_network=None, master_dns=None, worker_dns=None, master_dns_search_domains=None, master_ntp_servers=None, master_storage_policy=None, ephemeral_storage_policy=None, cns_file_config=None, login_banner=None, master_dns_names=None, image_storage=None, default_image_registry=None, default_image_repository=None, default_kubernetes_service_content_library=None, cluster_proxy_config=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.EnableSpec class contains the specification required to +enable vSphere Namespaces on a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size_hint (SizingHint) – This affects the size and resources allocated to the Kubernetes API +server. It also affects the suggested default serviceCidr and +podCidrs.

    • +

  • service_cidr (Ipv4Cidr) – CIDR block from which Kubernetes allocates service cluster IP +addresses. This range should not overlap with those in +Clusters.NCPClusterNetworkEnableSpec.pod_cidrs, +Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs, +Clusters.NCPClusterNetworkEnableSpec.egress_cidrs, or other +services running in the datacenter.

    • +

  • network_provider (Clusters.NetworkProvider) – The provider of cluster networking for this vSphere Namespaces +cluster.

    • +

  • ncp_cluster_network_spec (Clusters.NCPClusterNetworkEnableSpec) – Specification for the NSX Container Plugin cluster network. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN.

    • +

  • workload_networks_spec (Clusters.WorkloadNetworksEnableSpec) – Specification for the workload networks to be associated with the +cluster. This attribute was added in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.VSPHERE_NETWORK.

    • +

  • workload_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use for workloads +such as Tanzu Kubernetes Grid VMs, specified in order of +preference. This attribute was added in vSphere API 7.0.1.0. +If None, NTP server for Kubernetes API servers will be used.

    • +

  • load_balancer_config_spec (LoadBalancers.ConfigSpec) – The load balancer configuration is derived from the +user-provisioned load balancer that will be used to operate a load +balancer that fronts vSphere Namespaces cluster servers, Tanzu +Kubernetes Grid API servers, and other servers upon request. This +configuration is required for network providers that do not have a +default load balancer included. This attribute was added in vSphere +API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.VSPHERE_NETWORK.

    • +

  • master_management_network (Clusters.NetworkSpec) – Specification for the management network on Kubernetes API server. +Clusters.NetworkSpec.mode must be STATICRANGE as we require +Kubernetes API server to have a stable address.

    • +

  • master_dns (list of str or None) – List of DNS server IP addresses to use on Kubernetes API server, +specified in order of preference. +If None, no default DNS servers are set.

    • +

  • worker_dns (list of str or None) – List of DNS server IP addresses to use on the worker nodes, +specified in order of preference. +If None, no default DNS servers are set.

    • +

  • master_dns_search_domains (list of str or None) – List of domains (for example “vmware.com”) to be searched when +trying to lookup a host name on Kubernetes API server, specified in +order of preference. +If None, no default DNS search domains are set.

    • +

  • master_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use on Kubernetes +API server, specified in order of preference. +If None, VMware Tools based time synchronization is enabled.

    • +

  • master_storage_policy (str) – Identifier of storage policy associated with Kubernetes API server. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • ephemeral_storage_policy (str) – Identifier of storage policy associated with ephemeral disks of all +the Kubernetes Pods in the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • cns_file_config (CNSFileConfig or None) – Specification for configuring Cloud Native Storage file volume +support on Supervisor. This feature provides support for +provisioning ReadWriteMany persistent volumes on this cluster +and/or external clusters. This attribute was added in vSphere API +7.0.3.0. +If None, file volume support will not be enabled on this +Supervisor.

    • +

  • login_banner (str or None) – Disclaimer to be displayed prior to login via the Kubectl plugin. +If None, just skip it.

    • +

  • master_dns_names (list of str or None) – List of additional DNS names to associate with the Kubernetes API +server. These DNS names are embedded in the TLS certificate +presented by the API server. +If None, no additional DNS names are embedded in the TLS +certificate.

    • +

  • image_storage (Clusters.ImageStorageSpec) – Specification for storage to be used for container images.

    • +

  • default_image_registry (Clusters.ImageRegistry or None) – Default image registry to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. +If None, defaults to Docker Hub.

    • +

  • default_image_repository (str or None) – Default image repository to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. +If None, defaults to Docker Hub official repository in case of +Docker Hub image registry, otherwise defaults to empty string.

    • +

  • default_kubernetes_service_content_library (str or None) – Identifier of the Content Library which holds the VM Images for +vSphere Kubernetes Service. This Content Library should be +subscribed to VMware’s hosted vSphere Kubernetes Service +Repository. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +If None, the Content Library will be automatically generated and +configured to the cluster.

    • +

  • cluster_proxy_config (ProxyConfiguration or None) – Proxy configuration that will be applied to the Supervisor. The +proxy should be reachable from the management network and will be +used for image pulling and container traffic exiting out of the +Supervisor. This attribute was added in vSphere API 7.0.3.00100. +If None the settings will be inherited from the vCenter settings if +available.

    • +

  • content_libraries (list of Clusters.ContentLibrarySpec or None) – List of Content Libraries that will be associated with a +Supervisor. This list should refer to existing Content Libraries in +the vSphere inventory. These Content Libraries and the Content +Library items belonging to them will be read-only across all +vSphere Namespaces. This list cannot overlap with the +defaultKubernetesServiceContentLibrary. This attribute was added in +vSphere API 8.0.2.0. +If None, no additional Content Libraries will be set for the +Supervisor apart from the default Kubernetes Service Content +Library.

    • +
+
+
+
+ +
+
+class ImageRegistry(hostname=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.ImageRegistry class contains the specification required to +configure container image registry endpoint.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – IP address or the hostname of container image registry.

    • +

  • port (long or None) – Port number of the container image registry. +If None, defaults to 443.

    • +
+
+
+
+ +
+
+class ImageStorageSpec(storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.ImageStorageSpec class contains the specification required +to configure storage used for container images.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

storage_policy (str) – Identifier of the storage policy. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

+
+
+
+ +
+
+class Info(size_hint=None, stat_summary=None, config_status=None, conditions=None, messages=None, kubernetes_status=None, kubernetes_status_messages=None, api_server_management_endpoint=None, api_server_cluster_endpoint=None, api_servers=None, tls_management_endpoint_certificate=None, tls_endpoint_certificate=None, network_provider=None, ncp_cluster_network_info=None, workload_networks=None, workload_ntp_servers=None, load_balancers=None, service_cidr=None, master_management_network=None, master_dns=None, worker_dns=None, master_storage_policy=None, ephemeral_storage_policy=None, cns_file_config=None, login_banner=None, master_dns_names=None, image_storage=None, default_image_registry=None, default_image_repository=None, master_dns_search_domains=None, master_ntp_servers=None, default_kubernetes_service_content_library=None, cluster_proxy_config=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Info class contains detailed information about the cluster +statistics and status related to vSphere Namespaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size_hint (SizingHint) – Current setting for SizingHint. This affects the size and +resources allocated to the Kubernetes API server. This attribute +was added in vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • stat_summary (Clusters.Stats) – Basic runtime statistics for the cluster.

    • +

  • config_status (Clusters.ConfigStatus) – Current setting for Clusters.ConfigStatus.

    • +

  • conditions (list of Clusters.Condition) – The conditions that need to be met for the cluster to reach the +desired state. This attribute was added in vSphere API 8.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • messages (list of Clusters.Message) – Current set of messages associated with the object.

    • +

  • kubernetes_status (Clusters.KubernetesStatus) – Current setting for Clusters.KubernetesStatus.

    • +

  • kubernetes_status_messages (list of Clusters.Message) – Current set of messages associated with the object.

    • +

  • api_server_management_endpoint (str) – Kubernetes API Server IP address on the management network. This is +a floating IP and assigned to one of the control plane VMs on the +management network. This endpoint is used by vSphere components.

    • +

  • api_server_cluster_endpoint (str) – Kubernetes API Server IP address via cluster network. This is the +IP address of the Kubernetes LoadBalancer type service fronting the +apiservers. This endpoint is the one configured in kubeconfig after +login, and used for most human and application interaction with +Kubernetes.

    • +

  • api_servers (set of str) – Identifier of the Kubernetes API servers. These are the IP +addresses of the VM instances for the Kubernetes control plane on +the management network.

    • +

  • tls_management_endpoint_certificate (str or None) – PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API +servers when accessed from the management network, e.g. from ESX +servers or VCSA. +set only when +Clusters.Info.api_server_management_endpoint is used.

    • +

  • tls_endpoint_certificate (str or None) – PEM-encoded x509 certificate(s) used by TLS endpoint on Kubernetes +API servers when accessed via the load balancer, e.g. devops user +on corporate network. In case of a certificates chain, the order of +the certificates in this field is important. The first certificate +must be the leaf certificate for your domain name, the second the +intermediate certificate(s) and the last one must be the root +certificate. +set only when +Clusters.Info.api_server_management_endpoint is used.

    • +

  • network_provider (Clusters.NetworkProvider) – The provider of cluster networking for this vSphere Namespaces +cluster.

    • +

  • ncp_cluster_network_info (Clusters.NCPClusterNetworkInfo) – Specification for the NSX Container Plugin cluster network. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN.

    • +

  • workload_networks (Clusters.WorkloadNetworksInfo) – Information about workload networks associated with the cluster. +This attribute was added in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.VSPHERE_NETWORK.

    • +

  • workload_ntp_servers (list of str or None) – Information about NTP server DNS names or IP addresses to use for +workloads such as Tanzu Kubernetes Grid VMs, specified in order of +preference. This attribute was added in vSphere API 7.0.1.0. +None when NTP server for Kubernetes API servers is used.

    • +

  • load_balancers (list of LoadBalancers.Info) – Information related to the Load balancer used for provisioning +virtual servers in the namespace. This attribute was added in +vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.VSPHERE_NETWORK.

    • +

  • service_cidr (Ipv4Cidr) – CIDR block from which Kubernetes allocates service cluster IP +addresses.

    • +

  • master_management_network (Clusters.NetworkSpec) – Specification for the management network on Kubernetes API server. +This attribute was added in vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • master_dns (list of str or None) – List of DNS server IP addresses to use on Kubernetes API server, +specified in order of preference. +If None, no default DNS servers are set.

    • +

  • worker_dns (list of str or None) – List of DNS server IP addresses to use for pods that execute on the +worker nodes (which are native pods on ESXi hosts in the vSphere +Namespaces Supervisor). +If None, no default DNS servers are set.

    • +

  • master_storage_policy (str) – Identifier of storage policy associated with Kubernetes API server. +This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • ephemeral_storage_policy (str) – Identifier of storage policy associated with ephemeral disks of all +the Kubernetes Pods in the cluster. This attribute was added in +vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • cns_file_config (CNSFileConfig or None) – Specification for configuring Cloud Native Storage file volume +support on Supervisor. This feature provides support for +provisioning ReadWriteMany persistent volumes on this cluster +and/or external clusters. This attribute was added in vSphere API +7.0.3.0. +If None, it means the file volume support is not enabled on this +Supervisor.

    • +

  • login_banner (str or None) – Disclaimer to be displayed prior to login via the Kubectl plugin. +This attribute was added in vSphere API 7.0.1.0. +If None, just skip it.

    • +

  • master_dns_names (list of str or None) – List of additional DNS names to associate with the Kubernetes API +server. These DNS names are embedded in the TLS certificate +presented by the API server. This attribute was added in vSphere +API 7.0.1.0. +If None, no additional DNS names are embedded in the TLS +certificate.

    • +

  • image_storage (Clusters.ImageStorageSpec) – Specification for storage to be used for container images. This +attribute was added in vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • default_image_registry (Clusters.ImageRegistry or None) – Default image registry to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. This attribute was added in vSphere API 7.0.1.0. +If None, defaults to Docker Hub.

    • +

  • default_image_repository (str or None) – Default image repository to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. This attribute was added in vSphere API 7.0.1.0. +If None, defaults to Docker Hub official repository in case of +Docker Hub image registry, otherwise defaults to empty string.

    • +

  • master_dns_search_domains (list of str or None) – List of domains (for example “vmware.com”) to be searched when +trying to lookup a host name on Kubernetes API server, specified in +order of preference. +If None, no default DNS search domains are set.

    • +

  • master_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use on Kubernetes +API server, specified in order of preference. This attribute was +added in vSphere API 7.0.1.0. +If None, VMware Tools based time synchronization is enabled.

    • +

  • default_kubernetes_service_content_library (str or None) – Identifier of the Content Library which holds the VM Images for +vSphere Kubernetes Service. This Content Library should be +subscribed to VMware’s hosted vSphere Kubernetes Service +Repository. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +If None, a default subscribed Content Library will be created. It +will sync VMware-supplied images for Tanzu Kubernetes Grid over the +internet.

    • +

  • cluster_proxy_config (ProxyConfiguration) – Proxy configuration that is applied to the Supervisor. The proxy +should be reachable from the management network and is used for +image pulling and container traffic exiting out of the Supervisor. +Note that the proxy password will be removed from the URLs as per +Section 3.2.1 of RFC3986 security recommendation. This attribute +was added in vSphere API 7.0.3.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Clusters.ContentLibrarySpec or None) – List of Content Libraries associated with a Supervisor. This list +refers to existing Content Libraries in the vSphere inventory. +These Content Libraries and the Content Library items belonging to +them are read-only across all vSphere Namespaces. This list does +not overlap with the defaultKubernetesServiceContentLibrary. This +attribute was added in vSphere API 8.0.2.0. +If None, no additional Content Libraries will be set for the +Supervisor apart from the default Kubernetes Service Content +Library.

    • +
+
+
+
+ +
+
+class Ipv4Range(starting_address=None, address_count=None, subnet_mask=None, gateway=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Ipv4Range contains specification to configure multiple +interfaces in IPv4. The range of IPv4 addresses is derived by incrementing +the startingAddress to the specified addressCount. To use the object for a +single IPv4 address specification, set addressCount to 1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • starting_address (str) – The IPv4 address denoting the start of the range.

    • +

  • address_count (long) – The number of IP addresses in the range. Addresses are derived by +incrementing Clusters.Ipv4Range.starting_address.

    • +

  • subnet_mask (str) – Subnet mask to be set.

    • +

  • gateway (str) – The IPv4 address of the gateway associated with the range indicated +by Clusters.Ipv4Range.starting_address and +Clusters.Ipv4Range.address_count.

    • +
+
+
+
+ +
+
+class KubernetesStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.KubernetesStatus class describes the cluster’s ability to +deploy pods.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the KubernetesStatus instance.

+
+
+
+
+ERROR = KubernetesStatus(string='ERROR')
+

The cluster may not be able to accept pods and has error messages.

+
+ +
+
+READY = KubernetesStatus(string='READY')
+

The cluster is able to accept pods.

+
+ +
+
+WARNING = KubernetesStatus(string='WARNING')
+

The cluster may be able to accept pods, but has warning messages.

+
+ +
+ +
+
+class Message(severity=None, details=None, kb_article_link=None, id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Message class contains the information about the object +configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • severity (Clusters.Message.Severity) – Type of the message.

    • +

  • details (com.vmware.vapi.std_client.LocalizableMessage or None) – Details about the message. +If None, message details are not required for taking actions.

    • +

  • kb_article_link (str or None) – Optional link to a KB article providing more details about the +message. This attribute was added in vSphere API 8.0.2.0. +if None there is not KB article associated with the message.

    • +

  • id (str or None) – Unique identifier of the message. This attribute was added in +vSphere API 8.0.2.0. +if None there is no id associated with the message.

    • +
+
+
+
+
+class Severity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.Message.Severity class represents the severity of the +message.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Severity instance.

+
+
+
+
+ERROR = Severity(string='ERROR')
+

Error message. This is accompanied by vCenter event and/or alarm.

+
+ +
+
+INFO = Severity(string='INFO')
+

Informational message. This may be accompanied by vCenter event.

+
+ +
+
+WARNING = Severity(string='WARNING')
+

Warning message. This may be accompanied by vCenter event.

+
+ +
+ +
+ +
+
+class NCPClusterNetworkEnableSpec(pod_cidrs=None, ingress_cidrs=None, egress_cidrs=None, cluster_distributed_switch=None, nsx_edge_cluster=None, nsx_tier0_gateway=None, namespace_subnet_prefix=None, routed_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.NCPClusterNetworkEnableSpec class encapsulates the NSX +Container Plugin-specific cluster networking configuration parameters for +the vSphere Namespaces Cluster Enable operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pod_cidrs (list of Ipv4Cidr) – CIDR blocks from which Kubernetes allocates pod IP addresses. This +range should not overlap with those in +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs, +Clusters.NCPClusterNetworkEnableSpec.egress_cidrs, or other +services running in the datacenter. All Pod CIDR blocks must be of +at least subnet size /23.

    • +

  • ingress_cidrs (list of Ipv4Cidr) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. These +ranges should not overlap with those in +Clusters.NCPClusterNetworkEnableSpec.pod_cidrs, +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkEnableSpec.egress_cidrs, or other +services running in the datacenter.

    • +

  • egress_cidrs (list of Ipv4Cidr) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. These ranges should not +overlap with those in +Clusters.NCPClusterNetworkEnableSpec.pod_cidrs, +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs, or +other services running in the datacenter.

    • +

  • cluster_distributed_switch (str or None) – vSphere Distributed Switch used to connect this cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: vSphereDistributedSwitch. +This field is required when configuring a cluster that uses NSX-T. +If None and using NSXe, the system will choose a suitable vSphere +Distributed Switch.

    • +

  • nsx_edge_cluster (str or None) – NSX Edge Cluster to be used for Kubernetes Services of type +LoadBalancer, Kubernetes Ingresses, and NSX SNAT. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXEdgeCluster. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXEdgeCluster. +This field is required when configuring a cluster that uses NSX-T. +If None and using NSXe, the system will choose a suitable NSX Edge +Cluster.

    • +

  • nsx_tier0_gateway (str or None) – NSX Tier0 Gateway used for this cluster. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway. +This field is required when configuring a cluster that uses NSX-T.

    • +

  • namespace_subnet_prefix (long or None) – Size of the subnet reserved for namespaces segments. This attribute +was added in vSphere API 7.0.2.0. +If None, defaults to 28.

    • +

  • routed_mode (bool or None) – Routed mode for this cluster. When set to True, the traffic in the +cluster is not NATed. When this field is set to True, +Clusters.NCPClusterNetworkEnableSpec.egress_cidrs is not +allowed. This attribute was added in vSphere API 7.0.2.0. +If None, defaults to False.

    • +
+
+
+
+ +
+
+class NCPClusterNetworkInfo(pod_cidrs=None, ingress_cidrs=None, egress_cidrs=None, cluster_distributed_switch=None, nsx_edge_cluster=None, default_ingress_tls_certificate=None, nsx_tier0_gateway=None, namespace_subnet_prefix=None, routed_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.NCPClusterNetworkInfo class contains the NSX Container +Plugin-specific cluster networking configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pod_cidrs (list of Ipv4Cidr) – CIDR blocks from which Kubernetes allocates pod IP addresses.

    • +

  • ingress_cidrs (list of Ipv4Cidr) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer.

    • +

  • egress_cidrs (list of Ipv4Cidr) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs.

    • +

  • cluster_distributed_switch (str) – vSphere Distributed Switch used to connect this cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: vSphereDistributedSwitch.

    • +

  • nsx_edge_cluster (str) – NSX Edge Cluster to be used for Kubernetes Services of type +LoadBalancer, Kubernetes Ingresses, and NSX SNAT. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXEdgeCluster. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXEdgeCluster.

    • +

  • default_ingress_tls_certificate (str) – PEM-encoded x509 certificate used by NSX as a default fallback +certificate for Kubernetes Ingress services.

    • +

  • nsx_tier0_gateway (str or None) – NSX Tier0 Gateway used for this cluster. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway. +This is set when the cluster uses NSX-T.

    • +

  • namespace_subnet_prefix (long or None) – Size of the subnet reserved for namespaces segments. This attribute +was added in vSphere API 7.0.2.0. +If None, defaults to 28.

    • +

  • routed_mode (bool or None) – Routed mode for this cluster. This attribute was added in vSphere +API 7.0.2.0. +If None, defaults to False.

    • +
+
+
+
+ +
+
+class NCPClusterNetworkSetSpec(pod_cidrs=None, ingress_cidrs=None, egress_cidrs=None, default_ingress_tls_certificate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.NCPClusterNetworkSetSpec class encapsulates the NSX +Container Plugin-specific cluster networking configuration parameters for +the vSphere Namespaces Cluster Set operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pod_cidrs (list of Ipv4Cidr) – CIDR blocks from which Kubernetes allocates pod IP addresses. This +range should not overlap with those in +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkSetSpec.ingress_cidrs, +Clusters.NCPClusterNetworkSetSpec.egress_cidrs, or other +services running in the datacenter. A set operation only allows for +addition of new CIDR blocks to the existing list. All Pod CIDR +blocks must be of at least subnet size /23.

    • +

  • ingress_cidrs (list of Ipv4Cidr) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. These +ranges should not overlap with those in +Clusters.NCPClusterNetworkSetSpec.pod_cidrs, +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkSetSpec.egress_cidrs, or other +services running in the datacenter. A set operation only allows for +addition of new CIDR blocks to the existing list.

    • +

  • egress_cidrs (list of Ipv4Cidr) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. These ranges should not +overlap with those in +Clusters.NCPClusterNetworkSetSpec.pod_cidrs, +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkSetSpec.ingress_cidrs, or other +services running in the datacenter. A set operation only allows for +addition of new CIDR blocks to the existing list.

    • +

  • default_ingress_tls_certificate (str) – PEM-encoded x509 certificate used by NSX as a default fallback +certificate for Kubernetes Ingress services.

    • +
+
+
+
+ +
+
+class NCPClusterNetworkUpdateSpec(pod_cidrs=None, ingress_cidrs=None, egress_cidrs=None, default_ingress_tls_certificate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.NCPClusterNetworkUpdateSpec class encapsulates the NSX +Container Plugin-specific cluster networking configuration parameters for +the vSphere Namespaces Cluster Update operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pod_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which Kubernetes allocates pod IP addresses. This +range should not overlap with those in +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkUpdateSpec.ingress_cidrs, +Clusters.NCPClusterNetworkUpdateSpec.egress_cidrs, or other +services running in the datacenter. An update operation only allows +for addition of new CIDR blocks to the existing list. All Pod CIDR +blocks must be of at least subnet size /23. +If None, CIDRs from which Kubernetes allocates pod IP addresses +will not be modified.

    • +

  • ingress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. These +ranges should not overlap with those in +Clusters.NCPClusterNetworkUpdateSpec.pod_cidrs, +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkUpdateSpec.egress_cidrs, or other +services running in the datacenter. An update operation only allows +for addition of new CIDR blocks to the existing list. +If None, CIDRs from which Kubernetes allocates ingress IP addresses +will not be modified.

    • +

  • egress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. These ranges should not +overlap with those in +Clusters.NCPClusterNetworkUpdateSpec.pod_cidrs, +Clusters.EnableSpec.service_cidr, +Clusters.NCPClusterNetworkUpdateSpec.ingress_cidrs, or +other services running in the datacenter. An update operation only +allows for addition of new CIDR blocks to the existing list. +If None, CIDR from which Kubernetes allocates egress IP addresses +will not be modified.

    • +

  • default_ingress_tls_certificate (str or None) – PEM-encoded x509 certificate used by NSX as a default fallback +certificate for Kubernetes Ingress services. +If None, the Kubernetes Ingress services certificate will not be +modified.

    • +
+
+
+
+ +
+
+class NetworkProvider(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Identifies the network plugin that cluster networking functionalities for +this vSphere Namespaces Cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkProvider instance.

+
+
+
+
+NSXT_CONTAINER_PLUGIN = NetworkProvider(string='NSXT_CONTAINER_PLUGIN')
+

NSX-T Container Plugin.

+
+ +
+
+VSPHERE_NETWORK = NetworkProvider(string='VSPHERE_NETWORK')
+

vSphere Networking. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+ +
+
+class NetworkSpec(floating_ip=None, network=None, mode=None, address_range=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.NetworkSpec contains information related to network +configuration for one or more interfaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • floating_ip (str or None) – Optionally specify the Floating IP used by the cluster control +plane in case of DHCP. +If None, the existing effective management network floating IP will +be used.

    • +

  • network (str) – Identifier for the network. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network.

    • +

  • mode (Clusters.NetworkSpec.Ipv4Mode) – The address assignment mode.

    • +

  • address_range (Clusters.Ipv4Range) – Settings for the interfaces on the network. +This attribute is optional and it is only relevant when the value +of mode is Clusters.NetworkSpec.Ipv4Mode.STATICRANGE.

    • +
+
+
+
+
+class Ipv4Mode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.NetworkSpec.Ipv4Mode class defines various IPv4 address +assignment modes.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Ipv4Mode instance.

+
+
+
+
+DHCP = Ipv4Mode(string='DHCP')
+

The address is automatically assigned by a DHCP server.

+
+ +
+
+STATICRANGE = Ipv4Mode(string='STATICRANGE')
+

The address is static.

+
+ +
+ +
+ +
+
+class SetSpec(size_hint=None, floating_ip=None, network_provider=None, ncp_cluster_network_spec=None, master_dns=None, worker_dns=None, master_dns_search_domains=None, master_ntp_servers=None, master_storage_policy=None, ephemeral_storage_policy=None, cns_file_config=None, login_banner=None, image_storage=None, default_image_registry=None, default_image_repository=None, default_kubernetes_service_content_library=None, workload_ntp_servers=None, cluster_proxy_config=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.SetSpec class contains the specification required to set a +new configuration on the Cluster. This class is applied in entirety, +replacing the current specification fully.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size_hint (SizingHint) – This affects the size and resources allocated to the Kubernetes API +server.

    • +

  • floating_ip (str or None) – Optionally, you can edit the floating IP address that is assigned +to the Supervisor in case the DHCP server fails during the +Supervisor enablement process. The field is only relevant when the +DHCP mode of the Supervisor management network is set with +Clusters.EnableSpec.master_management_network. Set this +floating IP parameter to remediate a supervisor enablement failure +in the case where it was detected that the DHCP server does not +support DHCP client identifiers. This attribute was added in +vSphere API 7.0.3.0. +If None, the existing effective management network floating IP will +not be modified.

    • +

  • network_provider (Clusters.NetworkProvider) – The provider of cluster networking for this vSphere Namespaces +cluster.

    • +

  • ncp_cluster_network_spec (Clusters.NCPClusterNetworkSetSpec) – Specification for the NSX Container Plugin cluster network. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN.

    • +

  • master_dns (list of str or None) – List of DNS server IP addresses to use on Kubernetes API server, +specified in order of preference. +If None, DNS servers set on Kubernetes API server will be cleared.

    • +

  • worker_dns (list of str or None) – List of DNS server IP addresses to use on the worker nodes, +specified in order of preference. +If None, DNS servers set on worker nodes will be cleared.

    • +

  • master_dns_search_domains (list of str or None) – List of domains (for example “vmware.com”) to be searched when +trying to lookup a host name on Kubernetes API server, specified in +order of preference. +If None, DNS search domains set on Kubernetes API server will be +cleared.

    • +

  • master_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use on Kubernetes +API server, specified in order of preference. +If None, VMware Tools based time synchronization is enabled and any +set NTP servers are cleared.

    • +

  • master_storage_policy (str) – Identifier of storage policy associated with Kubernetes API server. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • ephemeral_storage_policy (str) – Identifier of storage policy associated with ephemeral disks of all +the Kubernetes Pods in the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • cns_file_config (CNSFileConfig or None) – Specification for configuring Cloud Native Storage file volume +support on Supervisor. This feature provides support for +provisioning ReadWriteMany persistent volumes on this cluster +and/or external clusters. This attribute was added in vSphere API +7.0.3.0. +If None, file volume support will not be enabled on this +Supervisor.

    • +

  • login_banner (str or None) – Disclaimer to be displayed prior to login via the Kubectl plugin. +If None, disclaimer to be displayed prior to login via the Kubectl +plugin will be cleared.

    • +

  • image_storage (Clusters.ImageStorageSpec) – Specification for storage to be used for container images.

    • +

  • default_image_registry (Clusters.ImageRegistry or None) – Default image registry to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. +If None, default image registry will be set to Docker Hub.

    • +

  • default_image_repository (str or None) – Default image repository to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. +If None, default image repository will be set to Docker Hub +official repository in case of Docker Hub image registry, otherwise +will be set to empty string.

    • +

  • default_kubernetes_service_content_library (str or None) – Identifier of the Content Library which holds the VM Images for +vSphere Kubernetes Service. This Content Library should be +subscribed to VMware’s hosted vSphere Kubernetes Service +Repository. Modifying or clearing the Content Library identifier +will not affect existing vSphere Kubernetes Service clusters. +However, upgrades or scale-out of existing clusters may be affected +if the new Content Library doesn’t have the necessary VM Images. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +If None, the Content Library identifier will be cleared.

    • +

  • workload_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use for workloads +such as Tanzu Kubernetes Grid VMs, specified in order of +preference. This attribute was added in vSphere API 7.0.1.0. +If None, NTP for Kubernetes API servers will be used.

    • +

  • cluster_proxy_config (ProxyConfiguration or None) – Proxy configuration that will be applied to the Supervisor. The +proxy should be reachable from the management network and will be +used for image pulling and container traffic exiting out of the +Supervisor. Modifying these settings will result in a restart of +the container runtime. Workloads might fail to pull their images +for a short period of time. There will be no effect on the +currently running containers. This attribute was added in vSphere +API 7.0.3.00100. +If None the settings will be inherited from the vCenter settings if +available.

    • +

  • content_libraries (list of Clusters.ContentLibrarySpec or None) – List of Content Libraries that will be associated a the Supervisor. +This list should refer to existing Content Libraries in the vSphere +inventory. These Content Libraries and the Content Library items +belonging to them will be read-only across all vSphere Namespaces. +This list cannot overlap with the +defaultKubernetesServiceContentLibrary. This attribute was added in +vSphere API 8.0.2.0. +If None, no additional Content Libraries will be set for the +Supervisor apart from the default Kubernetes Service Content +Library.

    • +
+
+
+
+ +
+
+class Stats(cpu_used=None, cpu_capacity=None, memory_used=None, memory_capacity=None, storage_used=None, storage_capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Stats class contains the basic runtime statistics about a +vSphere Namespaces-enabled cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu_used (long) – Overall CPU usage of the cluster, in MHz. This is the sum of CPU +usage across all worker nodes in the cluster.

    • +

  • cpu_capacity (long) – Total CPU capacity in the cluster available for vSphere Namespaces, +in MHz. This is the sum of CPU capacities from all worker nodes in +the cluster.

    • +

  • memory_used (long) – Overall memory usage of the cluster, in mebibytes. This is the sum +of memory usage across all worker nodes in the cluster.

    • +

  • memory_capacity (long) – Total memory capacity of the cluster available for vSphere +Namespaces, in mebibytes. This is the sum of memory capacities from +all worker nodesin the cluster.

    • +

  • storage_used (long) – Overall storage used by the cluster, in mebibytes. This is the sum +of storage used across all worker nodes in the cluster.

    • +

  • storage_capacity (long) – Overall storage capacity of the cluster available for vSphere +Namespaces, in mebibytes. This is the sum of total storage +available from all worker nodes in the cluster.

    • +
+
+
+
+ +
+
+class Summary(cluster=None, cluster_name=None, stats=None, config_status=None, kubernetes_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Summary class contains the basic information about the +cluster statistics and status related to vSphere Namespaces.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • cluster_name (str) – Name of the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: ClusterComputeResource.name.

    • +

  • stats (Clusters.Stats) – Basic runtime statistics for the cluster.

    • +

  • config_status (Clusters.ConfigStatus) – Current setting for Clusters.ConfigStatus.

    • +

  • kubernetes_status (Clusters.KubernetesStatus) – Current setting for Clusters.KubernetesStatus.

    • +
+
+
+
+ +
+
+class UpdateSpec(size_hint=None, floating_ip=None, network_provider=None, ncp_cluster_network_spec=None, master_dns=None, worker_dns=None, master_dns_search_domains=None, master_ntp_servers=None, master_storage_policy=None, ephemeral_storage_policy=None, cns_file_config=None, login_banner=None, image_storage=None, default_image_registry=None, default_image_repository=None, tls_endpoint_certificate=None, default_kubernetes_service_content_library=None, workload_ntp_servers=None, cluster_proxy_config=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.UpdateSpec class contains the specification required to +update the configuration on the Cluster. This class is applied partially, +and only the specified fields will replace or modify their existing +counterparts.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size_hint (SizingHint or None) – This affects the size and resources allocated to the Kubernetes API +server. +If None, size and resources allocated to Kubernetes API server will +not be modified.

    • +

  • floating_ip (str or None) – Optionally, you can edit the floating IP address that is assigned +to the Supervisor in case the DHCP server fails during the +Supervisor enablement process. The field is only relevant when the +DHCP mode of the Supervisor management network is set with +Clusters.EnableSpec.master_management_network. Set this +floating IP parameter to remediate a supervisor enablement failure +in the case where it was detected that the DHCP server does not +support DHCP client identifiers. This attribute was added in +vSphere API 7.0.3.0. +If None, the existing effective management network floating IP will +not be modified.

    • +

  • network_provider (Clusters.NetworkProvider or None) – The provider of cluster networking for this vSphere Namespaces +cluster. +If None, the existing effective cluster network specification will +not be modified.

    • +

  • ncp_cluster_network_spec (Clusters.NCPClusterNetworkUpdateSpec or None) – Updated specification for the cluster network configuration. +If None, the existing effective cluster network specification will +not be modified.

    • +

  • master_dns (list of str or None) – List of DNS server IP addresses to use on Kubernetes API server, +specified in order of preference. +If set, DNS servers set on Kubernetes API server will be +replaced. Otherwise, they will not be modified.

    • +

  • worker_dns (list of str or None) – List of DNS server IP addresses to use on the worker nodes, +specified in order of preference. +If set, DNS servers set on worker nodes will be replaced. +Otherwise, they will not be modified.

    • +

  • master_dns_search_domains (list of str or None) – List of domains (for example “vmware.com”) to be searched when +trying to lookup a host name on Kubernetes API server, specified in +order of preference. +If set, DNS search domains on Kubernetes API server will +be replaced. Otherwise, they will not be modified.

    • +

  • master_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use on Kubernetes +API server, specified in order of preference. +If set, NTP servers on Kubernetes API server will be +replaced. Otherwise, they will not be modified.

    • +

  • master_storage_policy (str or None) – Identifier of storage policy associated with Kubernetes API server. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +If None, storage policy associated with Kubernetes API server will +not be modified.

    • +

  • ephemeral_storage_policy (str or None) – Identifier of storage policy associated with ephemeral disks of all +the Kubernetes Pods in the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +If None, storage policy associated with ephemeral disks of all the +Kubernetes Pods will not be modified.

    • +

  • cns_file_config (CNSFileConfig or None) – Specification for configuring Cloud Native Storage file volume +support on Supervisor. This feature provides support for +provisioning ReadWriteMany persistent volumes on this cluster +and/or external clusters. This attribute was added in vSphere API +7.0.3.0. +If None, configuration for file volumes will remain unchanged.

    • +

  • login_banner (str or None) – Disclaimer to be displayed prior to login via the Kubectl plugin. +If None, disclaimer to be displayed prior to login via the Kubectl +plugin will not be modified.

    • +

  • image_storage (Clusters.ImageStorageSpec or None) – Specification for storage to be used for container images. +If None, configuration of storage used for container images is not +modified.

    • +

  • default_image_registry (Clusters.ImageRegistry or None) – Default image registry to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. +If None, default image registry will not be modified.

    • +

  • default_image_repository (str or None) – Default image repository to use when Kubernetes Pod container +specification does not specify it as part of the container image +name. +If None, default image repository will not be modified.

    • +

  • tls_endpoint_certificate (str or None) – PEM-encoded x509 certificate(s) issued for Kubernetes API Server. +Certificate(s) used must be created by signing the Certificate +Signing Request obtained from the Namespace Certificate Management +API. Because a Kubernetes CertificateSigningRequest is created on +an existing Namespaces-enabled cluster, you must use the +Clusters.UpdateSpec to specify this +Clusters.UpdateSpec.tls_endpoint_certificate on an existing +cluster rather than during initially enabling Namespaces on a +cluster. In case of providing the trust chain, the certificates +should be simply concatenated into a single string. +If None, Kubernetes API Server certificate(s) will not be modified.

    • +

  • default_kubernetes_service_content_library (str or None) – Identifier of the Content Library which holds the VM Images for +vSphere Kubernetes Service. This Content Library should be +subscribed to VMware’s hosted vSphere Kubernetes Service +Repository. Modifying or clearing the Content Library identifier +will not affect existing vSphere Kubernetes Service clusters. +However, upgrades or scale-out of existing clusters may be affected +if the new Content Library doesn’t have the necessary VM Images. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +If None, the Content Library will will not be modified.

    • +

  • workload_ntp_servers (list of str or None) – List of NTP server DNS names or IP addresses to use for workloads +such as Tanzu Kubernetes Grid VMs, specified in order of +preference. This attribute was added in vSphere API 7.0.1.0. +If None, NTP servers for workloads will be unmodified.

    • +

  • cluster_proxy_config (ProxyConfiguration or None) – Proxy configuration that will be applied to the Supervisor. The +proxy should be reachable from the management network and will be +used for image pulling and container traffic exiting out of the +Supervisor. Modifying these settings will result in a restart of +the container runtime. Workloads might fail to pull their images +for a short period of time. There will be no effect on the +currently running containers. This attribute was added in vSphere +API 7.0.3.00100. +If None no change will be made to the cluster.

    • +

  • content_libraries (list of Clusters.ContentLibrarySpec or None) – List of Content Libraries that will be associated with a +Supervisor. This list should refer to existing Content Libraries in +the vSphere inventory. These Content Libraries and the Content +Library items belonging to them will be read-only across all +vSphere Namespaces. This list cannot overlap with the +defaultKubernetesServiceContentLibrary. This attribute was added in +vSphere API 8.0.2.0. +If None, no additional Content Libraries will be set for the +Supervisor apart from the default Kubernetes Service Content +Library.

    • +
+
+
+
+ +
+
+class WorkloadNetworksEnableSpec(supervisor_primary_workload_network=None, network_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.WorkloadNetworksEnableSpec contains the specification +required to configure workload networks for a vSphere Namespaces Cluster +during Enable operation. These workload networks will be used as backing +network for Tanzu Kubernetes Cluster VMs and Kubernetes control plane VMs. +This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_primary_workload_network (Networks.CreateSpec) – The of the vSphere Namespaces network that will be used by +Kubernetes control plane VMs to expose Kubernetes API server to +devops users and other workloads. It can also used as backing +network for Tanzu Kubernetes Cluster VMs. This attribute was added +in vSphere API 7.0.1.0.

    • +

  • network_list (list of Networks.CreateSpec or None) – classes for additional list of vSphere Namespaces networks to be +associated with this cluster. This attribute was added in vSphere +API 7.0.1.0. +If None no additional networks will be associated with the cluster.

    • +
+
+
+
+ +
+
+class WorkloadNetworksInfo(supervisor_primary_workload_network=None, network_list=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.WorkloadNetworksInfo contains information related to +configuration of vSphere Namespaces Network objects. This class was added +in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_primary_workload_network (Networks.Info) – vSphere Namespaces network used by Kubernetes control plane VMs to +access load-balanced services on the various workload networks. +This attribute was added in vSphere API 7.0.1.0.

    • +

  • network_list (list of Networks.Info or None) – List of vSphere Namespaces networks associated with this cluster. +This attribute was added in vSphere API 7.0.1.0. +If None no additional networks are associated with the cluster.

    • +
+
+
+
+ +
+
+disable(cluster)
+

Disable vSphere Namespaces on the cluster. This operation tears down +the Kubernetes instance and the worker nodes associated with vSphere +Namespaces enabled cluster.

+
+
Parameters
+

cluster (str) – Identifier for the cluster for which vSphere Namespaces will be +disabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor cluster is being restored from a backup. When a +Supervisor cluster is restored, there’s a window of time during +which the restored Supervisor cluster’s state is being synchronized +back to vCenter. During that time, Supervisor cluster’s disablement +is not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
+
+ +
+
+enable(cluster, spec)
+

Enable vSphere Namespaces on the cluster. This operation sets up +Kubernetes instance for the cluster along with worker nodes.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which vSphere Namespaces will be +enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Clusters.EnableSpec) – Specification for setting up the Kubernetes API server and the +worker nodes.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the cluster already has vSphere Namespaces enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if resources/objects could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the specified cluster is not licensed or resource pool +reservation for control plane VMs fails.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster is not supported for vSphere Namespaces, +the cluster’s hosts do not have the required ESX version, or for +any other incompatibilities.

+
+
+
+ +
+
+get(cluster)
+

Returns information about a specific cluster.

+
+
Parameters
+

cluster (str) – Identifier for the cluster on which vSphere Namespaces are enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Clusters.Info

+
+
Returns
+

Information about the desired state of the specified cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster does not have vSphere Namespaces enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list()
+

Returns information about all clusters on which vSphere Namespaces are +enabled on this vCenter.

+
+
Return type
+

list of Clusters.Summary

+
+
Returns
+

List of summary of all clusters with vSphere Namespaces enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+rotate_password(cluster)
+

Request a new root password for all control plane nodes in the cluster. +This operation generates a new root password and configures every +control plane node in the cluster to accept it for authentication.

+
+
Parameters
+

cluster (str) – Identifier for the cluster for which the password is being +generated. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the cluster is in the process of password rotation.

+
+
+
+ +
+
+set(cluster, spec)
+

Set a new configuration on the cluster object. The specified +configuration is applied in entirety and will replace the current +configuration fully.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which vSphere Namespaces is enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Clusters.SetSpec) – New specification for the Supervisor cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if vSphere Namespaces is being disabled on this Supervisor cluster +or if the Supervisor cluster is being restored from a backup. When +a Supervisor cluster is restored, there’s a window of time during +which the restored Supervisor cluster’s state is being synchronized +back to vCenter. During that time, Supervisor cluster’s +configuration modifications are not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the Supervisor cluster’s hosts are not configured with +sufficient resources for the new Kubernetes API Server size.

+
+
+
+ +
+
+update(cluster, spec)
+

Update configuration on the cluster object. The specified configuration +is applied partially and None fields in spec will leave those parts +of configuration as-is.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which vSphere Namespaces is enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Clusters.UpdateSpec) – New specification for the Supervisor cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if vSphere Namespaces is being disabled on this Supervisor cluster +or if the Supervisor cluster is being restored from a backup. When +a Supervisor cluster is restored, there’s a window of time during +which the restored Supervisor cluster’s state is being synchronized +back to vCenter. During that time, Supervisor cluster’s +configuration modifications are not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the Supervisor cluster’s hosts are not configured with +sufficient resources for the new Kubernetes API Server size.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DistributedSwitchCompatibility class provides methods to get +Namespaces compatibility information of Distributed Switches in this +vCenter.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(compatible=None, network_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DistributedSwitchCompatibility.FilterSpec class contains attributes +used to filter the results when listing Distributed Switches (see +DistributedSwitchCompatibility.list()) and their compatibility +information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatible (bool or None) – Compatibility criteria for matching the filter. If true, only +Distributed Switches which are compatible with vSphere Namespaces +match the filter. If false, only Distributed Switches which are +incompatible with vSphere Namespaces match the filter. +If None, both compatible and incompatible Distributed Switches +match the filter.

    • +

  • network_provider (Clusters.NetworkProvider or None) – The network provider whose networks will be considered. If unset, +this will default to NSXT_CONTAINER_PLUGIN. This attribute was +added in vSphere API 7.0.1.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class Summary(distributed_switch=None, compatible=None, incompatibility_reasons=None, network_provider=None, compatible_networks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DistributedSwitchCompatibility.Summary class contains information +about the compatibility of a vSphere Distributed Switch with the Namespaces +feature.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • distributed_switch (str) – Identifier of the switch. If +DistributedSwitchCompatibility.Summary.network_provider is +either None or is set to NSXT_CONTAINER_PLUGIN, the value of this +field will refer to the UUID of a vim.DistributedVirtualSwitch. +Otherwise, the value of the field will refer to the ID of a +vim.DistributedVirtualSwitch. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: vSphereDistributedSwitch.

    • +

  • compatible (bool) – Compatibility of this switch with vSphere Namespaces.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage or None) – List of reasons for incompatibility. +If None, this Distributed Switch is compatible.

    • +

  • network_provider (Clusters.NetworkProvider or None) – The network provider whose networks were considered. This attribute +was added in vSphere API 7.0.1.0. +If None, clients clients should assume the value to be +NSXT_CONTAINER_PLUGIN.

    • +

  • compatible_networks (list of str or None) – List of compatible (PortGroup) Networks under the distributed +switch. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Network. When methods return a value of this class as a return +value, the attribute will contain identifiers for the resource +type: Network. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+list(cluster, filter=None)
+

Returns Namespaces compatibility information of Distributed Switches in +vCenter associated with the vCenter cluster, matching the +DistributedSwitchCompatibility.FilterSpec.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of a vCenter Cluster. Only Distributed Switches +associated with the vCenter Cluster will be considered by the +filter. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • filter (DistributedSwitchCompatibility.FilterSpec or None) – Specification of matching Distributed Switches for which +information should be returned. +If None, the behavior is equivalent to a +DistributedSwitchCompatibility.FilterSpec with all +attributes None which means all Distributed Switches match the +filter.

    • +
+
+
Return type
+

list of DistributedSwitchCompatibility.Summary

+
+
Returns
+

Namespaces compatibility information for Distributed Switches +matching the the +DistributedSwitchCompatibility.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +if the server reports an unknown internal error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster with the given cluster ID can be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EdgeClusterCompatibility class provides methods to get Namespaces +compatibility information of NSX Edge Clusters.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(compatible=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EdgeClusterCompatibility.FilterSpec class contains attributes used +to filter the results when listing Edge Clusters (see +EdgeClusterCompatibility.list()) and their compatibility information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

compatible (bool or None) – Compatibility criteria for matching the filter. If true, only Edge +Clusters which are compatible with vSphere Namespaces match the +filter. If false, only Edge Clusters which are incompatible with +vSphere Namespaces match the filter. +If None, both compatible and incompatible Edge Clusters match the +filter.

+
+
+
+ +
+
+class Summary(edge_cluster=None, display_name=None, compatible=None, incompatibility_reasons=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EdgeClusterCompatibility.Summary class contains information about +an NSX-T Edge Cluster, including its compatibility with the vCenter +Namespaces feature.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • edge_cluster (str) – Identifier of the Edge Cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXEdgeCluster. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXEdgeCluster.

    • +

  • display_name (str) – Display name of the Edge Cluster.

    • +

  • compatible (bool) – Compatibility of this Edge Cluster with Namespaces feature.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage or None) – List of reasons for incompatibility. +If None, this Edge Cluster is compatible.

    • +
+
+
+
+ +
+
+list(cluster, distributed_switch, filter=None)
+

Returns Namespaces compatibility information of NSX-T Edge Clusters +matching the EdgeClusterCompatibility.FilterSpec.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of a vCenter Cluster. Only Edge Clusters that are +associated with the particular vCenter Cluster will be considered +by the filter. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • distributed_switch (str) – Identifier of a Distributed Switch. Only Edge Clusters that are +associated with the particular Distributed Switch will be +considered by the filter. +The parameter must be an identifier for the resource type: +vSphereDistributedSwitch.

    • +

  • filter (EdgeClusterCompatibility.FilterSpec or None) – Specification of matching Edge Clusters for which information +should be returned. +If None, the behavior is equivalent to a +EdgeClusterCompatibility.FilterSpec with all attributes +None which means all Edge Clusters match the filter.

    • +
+
+
Return type
+

list of EdgeClusterCompatibility.Summary

+
+
Returns
+

List of summaries of Edge Clusters associated with the given +vCenter Cluster and Distributed Switch matching the +EdgeClusterCompatibility.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +if the server reports an unknown internal error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster with the given cluster ID can be found

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.HostsConfig(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The HostsConfig class provides methods to retrieve information about +vSphere Namespaces support and licensing.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(namespaces_supported=None, namespaces_licensed=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The HostsConfig.Info class contains information about vSphere +Namespaces support and licensing.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespaces_supported (bool) – True if vSphere Namespace feature is supported in this VC.

    • +

  • namespaces_licensed (bool) – True if vSphere Namespace feature is licensed on any hosts in this +VC.

    • +
+
+
+
+ +
+
+get()
+

Returns support and licensing information about hosts under a VC.

+
+
Return type
+

HostsConfig.Info

+
+
Returns
+

Information about vSphere Namespaces support and licensing.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.IPRange(address=None, count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IPRange class is used to express a range of IP addresses. The +formats supported by this structure will depend on the IP addressing scheme +that is being used by vSphere Namespaces. Currently, vSphere Namespaces +only supports IPv4. This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – The starting address of the range. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • count (long) – The number of IP addresses in the range. This attribute was added +in vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management_client.Ipv4Cidr(address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv4Cidr class contains the specification for representing CIDR +notation of IP range. For example, this can be used to represent 256 IP +addresses using 10.10.10.0/24.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – The IPv4 address.

    • +

  • prefix (long) – The CIDR prefix.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management_client.LoadBalancers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

LoadBalancers represent the user provisioned load balancers. The load +balancers provided may be used to front the API servers in both, vSphere +Namespaces Cluster and Tanzu Kubernetes Grid clusters. Note: The lifecycle +of these load balancers is not managed by vSphere. This class was added in +vSphere API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class AviConfigCreateSpec(server=None, username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LoadBalancers.AviConfigCreateSpec captures the configuration data +required for integration with the Avi Software Load Balancer. This class +was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server (LoadBalancers.Server) – Server is the address for the Avi Controller, used to configure +Virtual Servers. This attribute was added in vSphere API 7.0.2.0.

    • +

  • username (str) – An administrator user name for accessing the Avi Controller. This +attribute was added in vSphere API 7.0.2.0.

    • +

  • password (str) – The password for the administrator user. This attribute was added +in vSphere API 7.0.2.0.

    • +

  • certificate_authority_chain (str) – CertificateAuthorityChain contains PEM-encoded CA chain which is +used to verify x509 certificates received from the server. This +attribute was added in vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class AviConfigSetSpec(server=None, username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LoadBalancers.AviConfigSetSpec captures the configuration data required +for integration with the Avi Software Load Balancer. This class was added +in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server (LoadBalancers.Server) – Server is the address for the Avi Controller, used to configure +Virtual Servers. Note: This field cannot be updated and should +match existing value. This attribute was added in vSphere API +7.0.3.0.

    • +

  • username (str) – An administrator user name for accessing the Avi Controller. This +attribute was added in vSphere API 7.0.3.0.

    • +

  • password (str) – The password for the administrator user. This attribute was added +in vSphere API 7.0.3.0.

    • +

  • certificate_authority_chain (str) – CertificateAuthorityChain contains PEM-encoded CA chain which is +used to verify x509 certificates received from the server. This +attribute was added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class AviConfigUpdateSpec(username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LoadBalancers.AviConfigUpdateSpec captures the configuration data +required for integration with the Avi Software Load Balancer. This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • username (str or None) – An administrator user name for accessing the Avi Controller. This +attribute was added in vSphere API 7.0.3.0. +If None, the existing username will not be modified.

    • +

  • password (str or None) – The password for the administrator user. This attribute was added +in vSphere API 7.0.3.0. +If None, the existing password will not be modified.

    • +

  • certificate_authority_chain (str or None) – CertificateAuthorityChain contains PEM-encoded CA chain which is +used to verify x509 certificates received from the server. This +attribute was added in vSphere API 7.0.3.0. +If None, the existing PEM-encoded CA chain will not be modified.

    • +
+
+
+
+ +
+
+class AviInfo(server=None, username=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.AviInfo contains information related to the Avi +software load balancer in the namespace. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server (LoadBalancers.Server) – Server is the address for the Avi Controller, used to configure +Virtual Servers. This attribute was added in vSphere API 7.0.2.0.

    • +

  • username (str) – An administrator user name for accessing the Avi Controller. This +attribute was added in vSphere API 7.0.2.0.

    • +

  • certificate_authority_chain (str) – PEM-encoded CA certificate chain which is used to verify x509 +certificates received from the server. This attribute was added in +vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class ConfigSpec(id=None, address_ranges=None, provider=None, ha_proxy_config_create_spec=None, avi_config_create_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.ConfigSpec encapsulates load balancer configuration +on vSphere Namespaces. This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – An identifier that identifies a load balancer and can be used to +query or configure load balancer properties via these resources. +The identifier has DNS_LABEL restrictions as specified in ` +<https://tools.ietf.org/html/rfc1123>`_. This must be an +alphanumeric (a-z and 0-9) string, with a maximum length of 63 +characters and with the ‘-’ character allowed anywhere except the +first or last character. This name is unique across all Namespaces +in this vCenter server. This attribute was added in vSphere API +7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig.

    • +

  • address_ranges (list of IPRange) – List of address ranges that will be used to derive frontend IP +addresses for L4 virtual servers. This field is ignored in case of +AVI load balancer provider. In case of HA_PROXY load balancer +provider, at least one range must be provided. This attribute was +added in vSphere API 7.0.1.0.

    • +

  • provider (LoadBalancers.Provider) – The LoadBalancers.ConfigSpec.provider selects a provider +from the list of available providers to be used with vSphere +Namespaces. This attribute was added in vSphere API 7.0.1.0.

    • +

  • ha_proxy_config_create_spec (LoadBalancers.HAProxyConfigCreateSpec) – The LoadBalancers.HAProxyConfigCreateSpec is a conditional +configuration made available upon selecting the HA_PROXY load +balancer provider. It is used to configure the load balancer at run +time. This attribute was added in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of provider is LoadBalancers.Provider.HA_PROXY.

    • +

  • avi_config_create_spec (LoadBalancers.AviConfigCreateSpec) – The LoadBalancers.AviConfigCreateSpec is a conditional +configuration made available upon selecting the AVI load balancer +provider. It is used to configure the load balancer at run time. +This attribute was added in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of provider is LoadBalancers.Provider.AVI.

    • +
+
+
+
+ +
+
+class HAProxyConfigCreateSpec(servers=None, username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LoadBalancers.HAProxyConfigCreateSpec captures the configuration data +required for Supervisor Service Type:LoadBalancer to have an external load +balancer be created via HAProxy. This class was added in vSphere API +7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of LoadBalancers.Server) – Servers is a list of the addresses for the data plane API servers +used to configure Virtual Servers. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • username (str) – An administrator user name for accessing the HAProxy Data Plane API +server. This attribute was added in vSphere API 7.0.1.0.

    • +

  • password (str) – The password for the administrator user. This attribute was added +in vSphere API 7.0.1.0.

    • +

  • certificate_authority_chain (str) – CertificateAuthorityChain contains PEM-encoded CA chain which is +used to verify x509 certificates received from the server. This +attribute was added in vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class HAProxyConfigSetSpec(servers=None, username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LoadBalancers.HAProxyConfigSetSpec captures the configuration data +required for Supervisor Service Type:LoadBalancer to have an external load +balancer be created via HA Proxy. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of LoadBalancers.Server) – Servers is a list of the addresses for the data plane API servers +used to configure HAProxy. Note: This field cannot be updated and +should match existing list of servers. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • username (str) – An administrator user name for accessing the HAProxy Data Plane API +server. This attribute was added in vSphere API 7.0.3.0.

    • +

  • password (str) – The password for the administrator user. This attribute was added +in vSphere API 7.0.3.0.

    • +

  • certificate_authority_chain (str) – CertificateAuthorityChain contains PEM-encoded CA chain which is +used to verify x509 certificates received from the server. This +attribute was added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class HAProxyConfigUpdateSpec(username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

LoadBalancers.HAProxyConfigUpdateSpec captures the configuration data +required for Supervisor Service Type:LoadBalancer to have an external load +balancer be created via HAProxy. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • username (str or None) – An administrator user name for accessing the HAProxy Data Plane API +server. This attribute was added in vSphere API 7.0.3.0. +If None, the existing username will not be modified.

    • +

  • password (str or None) – The password for the administrator user. This attribute was added +in vSphere API 7.0.3.0. +If None, the existing password will not be modified.

    • +

  • certificate_authority_chain (str or None) – CertificateAuthorityChain contains PEM-encoded CA chain which is +used to verify x509 certificates received from the server. This +attribute was added in vSphere API 7.0.3.0. +If None, the existing PEM-encoded CA chain will not be modified.

    • +
+
+
+
+ +
+
+class HAProxyInfo(servers=None, username=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.HAProxyInfo contains information related to the +HAProxy load balancer in the namespace. This class was added in vSphere API +7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of LoadBalancers.Server) – A list of the addresses for the DataPlane API servers used to +configure HAProxy. This attribute was added in vSphere API 7.0.1.0.

    • +

  • username (str) – An administrator user name for accessing the HAProxy Data Plane API +server. This attribute was added in vSphere API 7.0.1.0.

    • +

  • certificate_authority_chain (str) – PEM-encoded CA certificate chain which is used to verify x509 +certificates received from the server. This attribute was added in +vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class Info(id=None, address_ranges=None, provider=None, ha_proxy_info=None, avi_info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.Info contains information related to the load +balancer for provisioning virtual servers in the namespace. This class was +added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – An DNS compliant identifier for a load balancer, which can be used +to query or configure the load balancer properties. This attribute +was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig.

    • +

  • address_ranges (list of IPRange) – IP address range from which virtual servers are assigned their IPs. +This attribute was added in vSphere API 7.0.1.0.

    • +

  • provider (LoadBalancers.Provider) – Load balancer provider for the namespace. This attribute was added +in vSphere API 7.0.1.0.

    • +

  • ha_proxy_info (LoadBalancers.HAProxyInfo) – The LoadBalancers.HAProxyInfo is a conditional configuration +made available upon selecting the HA_PROXY load balancer provider. +It is used to configure the load balancer at run time. This +attribute was added in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of provider is LoadBalancers.Provider.HA_PROXY.

    • +

  • avi_info (LoadBalancers.AviInfo) – The LoadBalancers.AviInfo is a conditional configuration made +available upon selecting the AVI load balancer provider. It is used +to configure the load balancer at run time. This attribute was +added in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of provider is LoadBalancers.Provider.AVI.

    • +
+
+
+
+ +
+
+class Provider(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LoadBalancers.Provider enumerates the kinds of load balancers +supported by vSphere Namespaces. This enumeration was added in vSphere API +7.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Provider instance.

+
+
+
+
+AVI = Provider(string='AVI')
+

NSX Advanced Load Balancer. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+
+HA_PROXY = Provider(string='HA_PROXY')
+

HAProxy load balancer. This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+ +
+
+class Server(host=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A LoadBalancers.Server represents an endpoint used to configure load +balancers. This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – Load balancer hostname or IPv4 address. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • port (long) – Load balancer port. This attribute was added in vSphere API +7.0.1.0.

    • +
+
+
+
+ +
+
+class SetSpec(address_ranges=None, provider=None, ha_proxy_config_set_spec=None, avi_config_set_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.SetSpec encapsulates configuration allowed for +setting a new configuration for a load balancer. This class was added in +vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address_ranges (list of IPRange) – List of address ranges that will be used to derive frontend IP +addresses for L4 virtual servers. This field is ignored in case of +AVI load balancer provider. In case of HA_PROXY load balancer +provider, at least one range must be provided. A set operation only +allows for addition of new IP ranges to the existing list of IP +ranges. This attribute was added in vSphere API 7.0.3.0.

    • +

  • provider (LoadBalancers.Provider) – The LoadBalancers.SetSpec.provider selects a provider from +the list of available providers to be used with vSphere Namespaces. +This attribute was added in vSphere API 7.0.3.0.

    • +

  • ha_proxy_config_set_spec (LoadBalancers.HAProxyConfigSetSpec) – The LoadBalancers.HAProxyConfigSetSpec is a conditional +configuration made available upon selecting the HA_PROXY load +balancer provider. It is used to configure the load balancer at run +time. This attribute was added in vSphere API 7.0.3.0. +This attribute is optional and it is only relevant when the value +of provider is LoadBalancers.Provider.HA_PROXY.

    • +

  • avi_config_set_spec (LoadBalancers.AviConfigSetSpec) – The LoadBalancers.AviConfigSetSpec is a conditional +configuration made available upon selecting the AVI load balancer +provider. It is used to configure the load balancer at run time. +This attribute was added in vSphere API 7.0.3.0. +This attribute is optional and it is only relevant when the value +of provider is LoadBalancers.Provider.AVI.

    • +
+
+
+
+ +
+
+class Summary(id=None, provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.Summary contains contains basic information related +to the load balancer for provisioning virtual servers in the namespace. +This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – An DNS compliant identifier for a load balancer, which can be used +to query or configure the load balancer properties. This attribute +was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig.

    • +

  • provider (LoadBalancers.Provider) – Load balancer provider for the namespace. This attribute was added +in vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class UpdateSpec(address_ranges=None, provider=None, ha_proxy_config_update_spec=None, avi_config_update_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LoadBalancers.UpdateSpec encapsulates configuration allowed for +when updating configuration for load balancers. This class was added in +vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address_ranges (list of IPRange or None) – List of address ranges that will be used to derive frontend IP +addresses for L4 virtual servers. This field is ignored in case of +AVI load balancer provider. In case of HA_PROXY load balancer +provider, at least one range must be provided. An update operation +only allows for addition of new IP ranges to the existing list of +IP ranges. This attribute was added in vSphere API 7.0.3.0. +If None, the existing list of address ranges will not be modified.

    • +

  • provider (LoadBalancers.Provider or None) – The LoadBalancers.UpdateSpec.provider selects a provider +from the list of available providers to be used with vSphere +Namespaces. This attribute was added in vSphere API 7.0.3.0. +If set, corresponding load balancer UpdateSpec will be +used to update the configuration. Note: This field cannot be +updated and can only be used a qualifer for the provider specific +update spec.

    • +

  • ha_proxy_config_update_spec (LoadBalancers.HAProxyConfigUpdateSpec or None) – The LoadBalancers.HAProxyConfigUpdateSpec is a conditional +configuration made available upon selecting the HA_PROXY load +balancer provider. It is used to configure the load balancer at run +time. This attribute was added in vSphere API 7.0.3.0. +If None, the HAProxy load balancer configuration will not be +modified.

    • +

  • avi_config_update_spec (LoadBalancers.AviConfigUpdateSpec or None) – The LoadBalancers.AviConfigUpdateSpec is a conditional +configuration made available upon selecting the AVI load balancer +provider. It is used to configure the load balancer at run time. +This attribute was added in vSphere API 7.0.3.0. +If None, the Avi load balancer configuration will not be modified.

    • +
+
+
+
+ +
+
+get(cluster, id)
+

Returns information LoadBalancers.Info about the load balancer +associated with the given cluster. This method was added in vSphere API +7.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster the load balancer is associated with. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • id (str) – Identifier of the load balancer +LoadBalancers.ConfigSpec.id. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig.

    • +
+
+
Return type
+

LoadBalancers.Info

+
+
Returns
+

Information about load balancer associated with a cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or id cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster does not have vSphere Namespaces enabled.

+
+
+
+ +
+
+list(cluster)
+

Returns information about all load balancers associated with the given +cluster. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster the load balancers are associated with. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

list of LoadBalancers.Summary

+
+
Returns
+

List of summary of all load balancers associated with a clusters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster does not have vSphere Namespaces enabled.

+
+
+
+ +
+
+set(cluster, id, spec)
+

Applies the entire load balancer spec to an existing load balancer +configuration. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster the load balancer is associated with. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • id (str) – Identifier of the load balancer. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig.

    • +

  • spec (LoadBalancers.SetSpec) – Information about the load balancer object to be set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated cluster is being disabled or if the load balancer +config is already marked for delete.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or id cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster does not have vSphere Namespaces enabled.

+
+
+
+ +
+
+update(cluster, id, spec)
+

Updates the load balancer configuration. The specified configuration is +applied partially and None fields in spec will leave those parts of +configuration as-is. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster the load balancer is associated with. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • id (str) – Identifier of the load balancer. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.LoadBalancerConfig.

    • +

  • spec (LoadBalancers.UpdateSpec) – Information about the load balancer object to be updated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated cluster is being disabled or if the load balancer +config is already marked for delete.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or id cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster does not have vSphere Namespaces enabled.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.NSXTier0Gateway(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The NSXTier0Gateway provides methods to get information of NSX Tier0 +Gateways. This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Summary(tier0_gateway=None, display_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NSXTier0Gateway.Summary class contains information about an NSX-T +Tier0 Gateway. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • tier0_gateway (str) – Identifier of the NSX-T Tier0 or Tier0-VRF Gateway. This attribute +was added in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway.

    • +

  • display_name (str) – Display name of the NSX-T Gateway. This attribute was added in +vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+list(distributed_switch)
+

Returns information of NSX-T Tier0 Gateways associated with a +Distributed Switch. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+

distributed_switch (str) – Identifier of a Distributed Switch. Only CVDS type of distributed +switches is supported. Only Tier0 Gateways that are associated with +the particular Distributed Switch will be listed. +The parameter must be an identifier for the resource type: +vSphereDistributedSwitch.

+
+
Return type
+

list of NSXTier0Gateway.Summary

+
+
Returns
+

List of summaries of Tier0 Gateways associated with the given +Distributed Switch.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InternalServerError +if the server reports an unknown internal error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no existing Tier0 Gateways associated with the given Distributed +Switch can be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The NamespaceResourceOptions class provides methods to get the objects +used to create and modify resource quotas on a namespace.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(create_resource_quota_type=None, update_resource_quota_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceResourceOptions.Info class contains the information about +the objects used to set and update resource quota keys on a namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • create_resource_quota_type (str) – Identifier of the class used to set resource quotas on the +namespace. See com.vmware.vcenter.namespaces.Instances#create and +com.vmware.vcenter.namespaces.Instances#set. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure.

    • +

  • update_resource_quota_type (str) – Identifier of the class used to update resource quotas on the +namespace. See com.vmware.vcenter.namespaces.Instances#update. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vapi.structure. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.vapi.structure.

    • +
+
+
+
+ +
+
+get(cluster)
+

Get the information about the objects used to set and update resource +quota keys for version of Kubernetes running on {#link cluster}.

+
+
Parameters
+

cluster (str) – Identifier for the cluster hosting the namespace on which the +resource quota needs to be set. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

NamespaceResourceOptions.Info

+
+
Returns
+

Information about the structures representing the resource spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster is not enabled for Namespaces.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.Networks(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Networks class provides lifecycle methods on vSphere Namespaces +networks associated with a vSphere cluster. This class was added in vSphere +API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(network=None, network_provider=None, vsphere_network=None, nsx_network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.CreateSpec class contains the specification required to +create a vSphere Namespaces network object. This class was added in vSphere +API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (str) – Identifier of the network. This has DNS_LABEL restrictions as +specified in ` <https://tools.ietf.org/html/rfc1123>`_. This must +be an alphanumeric (a-z and 0-9) string and with maximum length of +63 characters and with the ‘-’ character allowed anywhere except +the first or last character. This name must be unique within a +cluster. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network.

    • +

  • network_provider (Clusters.NetworkProvider) – The network provider that will manage the vSphere Namespaces +network object. This attribute was added in vSphere API 7.0.1.0.

    • +

  • vsphere_network (Networks.VsphereDVPGNetworkCreateSpec) – The create spec for a DVPG-backed Namespaces network object, +supported by Clusters.NetworkProvider.VSPHERE_NETWORK +network provider. This attribute was added in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.VSPHERE_NETWORK.

    • +

  • nsx_network (Networks.NsxNetworkCreateSpec) – The create spec for a NSXT-backed Namespaces network configuration, +supported by Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN +network provider. This attribute was added in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN.

    • +
+
+
+
+ +
+
+class IPAssignmentMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Networks.IPAssignmentMode class defines various IP address +assignment modes. This enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IPAssignmentMode instance.

+
+
+
+
+DHCP = IPAssignmentMode(string='DHCP')
+

The address is automatically assigned by a DHCP server. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+STATICRANGE = IPAssignmentMode(string='STATICRANGE')
+

The address is assigned from a static range. This class attribute was added +in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class Info(network=None, network_provider=None, vsphere_network=None, nsx_network=None, namespaces=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.Info class contains detailed information about a specific +vSphere Namespaces network. This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (str) – Identifier of the network. This attribute was added in vSphere API +7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network.

    • +

  • network_provider (Clusters.NetworkProvider) – The network provider that will manage the vSphere Namespaces +network object. This attribute was added in vSphere API 7.0.1.0.

    • +

  • vsphere_network (Networks.VsphereDVPGNetworkInfo) – Updated configuration specification for a DVPG-backed Namespaces +network object, supported by +Clusters.NetworkProvider.VSPHERE_NETWORK network provider. +This attribute was added in vSphere API 7.0.1.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.VSPHERE_NETWORK.

    • +

  • nsx_network (Networks.NsxNetworkInfo) – Configuration specification for a NSXT-backed Namespaces network +configuration, supported by +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN network +provider. This attribute was added in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of networkProvider is +Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN.

    • +

  • namespaces (list of str or None) – A list of Supervisor Namespaces associated with this network. This +attribute was added in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.namespaces.Instance. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class LoadBalancerSize(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Networks.LoadBalancerSize enumerates the kinds of load balancer +sizes supported by NSX. Small load balancer can host 10 to 20 virtual +servers depending on NSX-T version. Medium load balancer can host 100 +virtual servers. Large load balancer can host 1000 virtual servers. This +enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LoadBalancerSize instance.

+
+
+
+
+LARGE = LoadBalancerSize(string='LARGE')
+

Load balancer size of ‘large’. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+MEDIUM = LoadBalancerSize(string='MEDIUM')
+

Load balancer size of ‘medium’. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+SMALL = LoadBalancerSize(string='SMALL')
+

Load balancer size of ‘small’. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+ +
+
+class NsxNetworkCreateSpec(namespace_network_cidrs=None, ingress_cidrs=None, egress_cidrs=None, nsx_tier0_gateway=None, subnet_prefix_length=None, routed_mode=None, load_balancer_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.NsxNetworkCreateSpec class describes the configuration +specification of a NSXT-backed Namespaces Network configuration. This class +was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace_network_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which Kubernetes allocates IP addresss for all +workloads that attach to the namespace, including PodVMs, TKGS and +VM Service VMs. This range should not overlap with those in +Networks.NsxNetworkCreateSpec.ingress_cidrs, +Networks.NsxNetworkCreateSpec.egress_cidrs, or other +services running in the datacenter. This attribute was added in +vSphere API 7.0.2.0. +This field is required when +Networks.NsxNetworkCreateSpec.nsx_tier0_gateway or any of +Networks.NsxNetworkCreateSpec.ingress_cidrs, +Networks.NsxNetworkCreateSpec.egress_cidrs are specified. +An update operation only allows for addition of new CIDR blocks to +the existing list.

    • +

  • ingress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. These +ranges should not overlap with those in +Networks.NsxNetworkCreateSpec.namespace_network_cidrs, +Networks.NsxNetworkCreateSpec.egress_cidrs, or other +services running in the datacenter. This attribute was added in +vSphere API 7.0.2.0. +This field is required when +Networks.NsxNetworkCreateSpec.nsx_tier0_gateway or any of +Networks.NsxNetworkCreateSpec.namespace_network_cidrs, +Networks.NsxNetworkCreateSpec.egress_cidrs is specified. An +update operation only allows for addition of new CIDR blocks to the +existing list.

    • +

  • egress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. These ranges should not +overlap with those in +Networks.NsxNetworkCreateSpec.namespace_network_cidrs, +Networks.NsxNetworkCreateSpec.ingress_cidrs, or other +services running in the datacenter. This attribute was added in +vSphere API 7.0.2.0. +This field is required when +Networks.NsxNetworkCreateSpec.routed_mode is set to False +and Networks.NsxNetworkCreateSpec.nsx_tier0_gateway or any +of Networks.NsxNetworkCreateSpec.namespace_network_cidrs, +Networks.NsxNetworkCreateSpec.ingress_cidrs is specified. +When Networks.NsxNetworkCreateSpec.routed_mode is set to +True, this field is not allowed. An update operation only allows +for addition of new CIDR blocks to the existing list.

    • +

  • nsx_tier0_gateway (str or None) – NSX Tier0 Gateway used for the namespace. This field does not allow +update once applied. This attribute was added in vSphere API +7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway. +This field is required when configuring a cluster that uses NSX-T.

    • +

  • subnet_prefix_length (long or None) – Size of the subnet reserved for namespace segments. This attribute +was added in vSphere API 7.0.2.0. +If None, defaults to 28. This field does not allow update once +applied.

    • +

  • routed_mode (bool or None) – Routed mode for thw namespace. When set to True, the traffic in the +namespace is not NATed. This attribute was added in vSphere API +7.0.2.0. +If None, defaults to False. When this field is set to True, +Networks.NsxNetworkCreateSpec.egress_cidrs is not allowed. +This field does not allow update once applied.

    • +

  • load_balancer_size (Networks.LoadBalancerSize or None) – The size of the NSX Load Balancer used by the namespace. This field +does not allow update once applied. This attribute was added in +vSphere API 7.0.2.0. +If None, defaults to Networks.LoadBalancerSize.SMALL.

    • +
+
+
+
+ +
+
+class NsxNetworkInfo(namespace_network_cidrs=None, ingress_cidrs=None, egress_cidrs=None, nsx_tier0_gateway=None, subnet_prefix_length=None, routed_mode=None, load_balancer_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.NsxNetworkInfo class describes the configuration +specification of a NSXT-backed Namespaces Network configuration. This class +was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace_network_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which Kubernetes allocates IP addresses for all +workloads that attach to the namespace, including PodVMs, TKGS and +VM Service VMs. This attribute was added in vSphere API 7.0.2.0. +If None, cluster level settings specified in +Clusters.NCPClusterNetworkInfo.pod_cidrs will be applied.

    • +

  • ingress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. This +attribute was added in vSphere API 7.0.2.0. +If None, cluster level settings specified in +Clusters.NCPClusterNetworkInfo.ingress_cidrs will be +applied.

    • +

  • egress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. This attribute was added +in vSphere API 7.0.2.0. +If None, cluster level settings specified in +Clusters.NCPClusterNetworkInfo.egress_cidrs will be +applied.

    • +

  • nsx_tier0_gateway (str or None) – NSX Tier0 Gateway used for this namespace. This attribute was added +in vSphere API 7.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway. +If None, cluster level settings specified in +Clusters.NCPClusterNetworkInfo.nsx_tier0_gateway will be +applied.

    • +

  • subnet_prefix_length (long or None) – Size of the subnet reserved for namespace segments. This attribute +was added in vSphere API 7.0.2.0. +If None, cluster level settings specified in +Clusters.NCPClusterNetworkInfo.namespace_subnet_prefix will +be applied.

    • +

  • routed_mode (bool or None) – Routed mode for this namespace. When set to True, the traffic in +the namespace is not NATed. This attribute was added in vSphere API +7.0.2.0. +If None, cluster level settings specified in +Clusters.NCPClusterNetworkInfo.routed_mode will be applied.

    • +

  • load_balancer_size (Networks.LoadBalancerSize or None) – The size of the NSX Load Balancer used by the namespace. This +attribute was added in vSphere API 7.0.2.0. +If None, then Networks.LoadBalancerSize.SMALL is used.

    • +
+
+
+
+ +
+
+class NsxNetworkSetSpec(namespace_network_cidrs=None, ingress_cidrs=None, egress_cidrs=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.NsxNetworkSetSpec class contains new configuration to set +on an existing NSXT-backed Namespaces Network configuration. This class was +added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace_network_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which Kubernetes allocates IP addresses for all +workloads that attach to the namespace, including PodVMs, TKGS and +VM Service VMs. Only appending additional Cidr is allowed. +Modification to existing Cidr ranges will result in the operation +failing with a com.vmware.vapi.std.errors_client.ResourceInUse +exception. Appending invalid Cidr e.g. overlapping or broadcast or +reserved Cidr will result in the operation failing with a +com.vmware.vapi.std.errors_client.InvalidArgument exception. +This attribute was added in vSphere API 7.0.2.0. +If None, the current value will be retained.

    • +

  • ingress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. Only +appending additional Cidr is allowed. Modification to existing Cidr +ranges will result in the operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. +Appending invalid Cidr e.g. overlapping or broadcast or reserved +Cidr will result in the operation failing with a +com.vmware.vapi.std.errors_client.InvalidArgument exception. +This attribute was added in vSphere API 7.0.2.0. +If None, the current value will be retained.

    • +

  • egress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. Only appending additional +Cidr is allowed. Modification to existing Cidr ranges will result +in the operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. +Appending invalid Cidr e.g. overlapping or broadcast or reserved +Cidr will result in the operation failing with a +com.vmware.vapi.std.errors_client.InvalidArgument exception. +This attribute was added in vSphere API 7.0.2.0. +If None, the current value will be retained.

    • +
+
+
+
+ +
+
+class NsxNetworkUpdateSpec(namespace_network_cidrs=None, ingress_cidrs=None, egress_cidrs=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.NsxNetworkUpdateSpec class contains new configuration to +update on an existing a NSXT-backed Namespaces Network configuration. This +class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace_network_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which Kubernetes allocates IP addresses for all +workloads that attach to the namespace, including PodVMs, TKGS and +VM Service VMs. Only appending additional Cidr is allowed. +Modification to existing Cidr ranges will result in the operation +failing with a com.vmware.vapi.std.errors_client.ResourceInUse +exception. Appending invalid Cidr e.g. overlapping or broadcast or +reserved Cidr will result in the operation failing with a +com.vmware.vapi.std.errors_client.InvalidArgument exception. +This attribute was added in vSphere API 7.0.2.0. +If None, the current value will be retained.

    • +

  • ingress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. Only +appending additional Cidr is allowed. Modification to existing Cidr +ranges will result in the operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. +Appending invalid Cidr e.g. overlapping or broadcast or reserved +Cidr will result in the operation failing with a +com.vmware.vapi.std.errors_client.InvalidArgument exception. +This attribute was added in vSphere API 7.0.2.0. +If None, the current value will be retained.

    • +

  • egress_cidrs (list of Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. Only appending additional +Cidr is allowed. Modification to existing Cidr ranges will result +in the operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. +Appending invalid Cidr e.g. overlapping or broadcast or reserved +Cidr will result in the operation failing with a +com.vmware.vapi.std.errors_client.InvalidArgument exception. +This attribute was added in vSphere API 7.0.2.0. +If None, the current value will be retained.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.namespace_management.Network'
+

The resource type for network. This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+
+class SetSpec(network_provider=None, vsphere_network=None, nsx_network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.SetSpec class contains the specification required to set a +new configuration of a vSphere Namespaces network object. This class is +applied in entirety, replacing the current specification fully. This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class UpdateSpec(network_provider=None, vsphere_network=None, nsx_network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.UpdateSpec class contains the specification required to +update the configuration of a vSphere Namespaces network object. This class +is applied partially, and only the specified fields will replace or modify +their existing counterparts. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class VsphereDVPGNetworkCreateSpec(portgroup=None, ip_assignment_mode=None, address_ranges=None, gateway=None, subnet_mask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.VsphereDVPGNetworkCreateSpec class describes the +configuration specification of a vSphere DVPG-backed Namespaces Network +object. This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • portgroup (str) – Identifier of the vSphere Distributed Portgroup backing the vSphere +network object. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network.

    • +

  • ip_assignment_mode (Networks.IPAssignmentMode or None) – IP address assignment mode. If set to DHCP, then field +Networks.VsphereDVPGNetworkCreateSpec.address_ranges must +be set to an empty list and fields +Networks.VsphereDVPGNetworkCreateSpec.gateway and +Networks.VsphereDVPGNetworkCreateSpec.subnet_mask must be +set to empty strings. This attribute was added in vSphere API +7.0.3.0. +If None, defaults to STATICRANGE.

    • +

  • address_ranges (list of IPRange) – Usable IP pools on this network. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • gateway (str) – Gateway for the network. This attribute was added in vSphere API +7.0.1.0.

    • +

  • subnet_mask (str) – Subnet mask of the network. This attribute was added in vSphere API +7.0.1.0.

    • +
+
+
+
+ +
+
+class VsphereDVPGNetworkInfo(portgroup=None, ip_assignment_mode=None, address_ranges=None, gateway=None, subnet_mask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.VsphereDVPGNetworkInfo class describes the configuration +specification of a vSphere DVPG-backed Namespaces Network object. This +class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • portgroup (str) – Identifier of the vSphere Distributed Portgroup backing the vSphere +network object. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network.

    • +

  • ip_assignment_mode (Networks.IPAssignmentMode or None) – IP address assignment mode. This attribute was added in vSphere API +7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • address_ranges (list of IPRange) – Usable IP pools on this network. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • gateway (str) – Gateway for the network. This attribute was added in vSphere API +7.0.1.0.

    • +

  • subnet_mask (str) – Subnet mask of the network. This attribute was added in vSphere API +7.0.1.0.

    • +
+
+
+
+ +
+
+class VsphereDVPGNetworkSetSpec(portgroup=None, address_ranges=None, gateway=None, subnet_mask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.VsphereDVPGNetworkSetSpec class contains new configuration +to set on an existing a vSphere DVPG-backed Namespaces Network object. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • portgroup (str) – Identifier of the vSphere Distributed Portgroup backing the vSphere +network object. If the network object is associated with a +Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +modification to existing portgroup will result in the operation +failing with a com.vmware.vapi.std.errors_client.ResourceInUse +exception. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network.

    • +

  • address_ranges (list of IPRange) – Usable IP pools on this network. If the network object is +associated with a Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then replacement of or modification to any existing range in this +list will result in operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. To +add new address ranges to the list, existing address ranges have to +be passed in without modifications. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • gateway (str) – Gateway for the network. If the network object is associated with a +Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then modification to existing gateway will result in the operation +failing with a com.vmware.vapi.std.errors_client.ResourceInUse +exception. This attribute was added in vSphere API 7.0.3.0.

    • +

  • subnet_mask (str) – Subnet mask of the network. If the network object is associated +with a Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then modification to existing subnet mask will result in the +operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. This +attribute was added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class VsphereDVPGNetworkUpdateSpec(portgroup=None, address_ranges=None, gateway=None, subnet_mask=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networks.VsphereDVPGNetworkUpdateSpec class contains new +configuration to update on an existing a vSphere DVPG-backed Namespaces +Network object. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • portgroup (str or None) – Identifier of the vSphere Distributed Portgroup backing the vSphere +network object. If the network object is associated with a +Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then modification to existing portgroup will result in the +operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. This +attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network. +If None, the current value will be retained.

    • +

  • address_ranges (list of IPRange or None) – Usable IP pools on this network. If the network object is +associated with a Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then replacement of or modification to any existing range in this +list will result in operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. To +add new address ranges to the list, existing address ranges have to +be passed in without modifications. This attribute was added in +vSphere API 7.0.3.0. +If None, the current value will be retained.

    • +

  • gateway (str or None) – Gateway for the network. If the network object is associated with a +Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then modification to existing gateway will result in the operation +failing with a com.vmware.vapi.std.errors_client.ResourceInUse +exception. This attribute was added in vSphere API 7.0.3.0. +If None, the current value will be retained.

    • +

  • subnet_mask (str or None) – Subnet mask of the network. If the network object is associated +with a Namespace or is +Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network, +then modification to existing subnet mask will result in the +operation failing with a +com.vmware.vapi.std.errors_client.ResourceInUse exception. This +attribute was added in vSphere API 7.0.3.0. +If None, the current value will be retained.

    • +
+
+
+
+ +
+
+create(cluster, spec)
+

Create a vSphere Namespaces network object associated with the given +cluster. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Networks.CreateSpec) – Information about the network object to be created.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a network by the name as specified in the +Networks.CreateSpec already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated cluster is being disabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if spec contains NsxNetworkCreateSpec which is unsupported via +create API.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
+
+ +
+
+delete(cluster, network)
+

Delete the vSphere Namespaces object in the cluster. This method was +added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • network (str) – Identifier for the vSphere Namespaces network. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or network could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the network is associated with a Namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
+
+ +
+
+get(cluster, network)
+

Return information about a specific vSphere Namespaces network. This +method was added in vSphere API 7.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • network (str) – Identifier for the vSphere Namespaces network. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network.

    • +
+
+
Return type
+

Networks.Info

+
+
Returns
+

List of information about all vSphere Namespaces networks in the +cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or network could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list(cluster)
+

Return information about all vSphere Namespaces networks in the +cluster. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+

cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

list of Networks.Info

+
+
Returns
+

Information about the specified vSphere Namespaces network..

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or network could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+set(cluster, network, spec)
+

Set a new configuration for the vSphere Namespaces network object +associated with the given cluster. This method was added in vSphere API +7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • network (str) – Identifier for the vSphere Namespaces network. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network.

    • +

  • spec (Networks.SetSpec) – Information about the network object to be set.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated cluster is being disabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or the network cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the network is in use and the spec contains field values +that are un-settable in such a case.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
+
+ +
+
+update(cluster, network, spec)
+

Update the configuration of the vSphere Namespaces network object +associated with the given cluster. This method was added in vSphere API +7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • network (str) – Identifier for the vSphere Namespaces network. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network.

    • +

  • spec (Networks.UpdateSpec) – Information about the network object to be updated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated cluster is being disabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster or the network cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the network is in use and the spec contains field values +that are un-updatable in such a case.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.ProxyConfiguration(proxy_settings_source=None, https_proxy_config=None, http_proxy_config=None, no_proxy_config=None, tls_root_ca_bundle=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ProxyConfiguration class defines proxy configuration to be used by +the Supervisor. This class was added in vSphere API 7.0.3.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • proxy_settings_source (ProxySettingsSource) – The source of the proxy settings. If +ProxySettingsSource.VC_INHERITED or +ProxySettingsSource.NONE is specified, then the other +configuration in ProxyConfiguration will be ignored. This +attribute was added in vSphere API 7.0.3.00100.

    • +

  • https_proxy_config (str or None) –

    HTTPS proxy configuration. Examples:

    + +

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED +is used for the source, otherwise this will be ignored. This +attribute was added in vSphere API 7.0.3.00100. +If None no HTTPS proxy will be used.

    +

    • +

  • http_proxy_config (str or None) –

    HTTP proxy configuration. Examples:

    + +

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED +is used for the source, otherwise this will be ignored. This +attribute was added in vSphere API 7.0.3.00100. +If None no HTTP proxy will be used.

    +

    • +

  • no_proxy_config (list of str or None) – List of addresses that should be accessed directly. This will be +used if ProxySettingsSource.CLUSTER_CONFIGURED is used for +the source, otherwise this will be ignored. This attribute was +added in vSphere API 7.0.3.00100. +If None there won’t be any excluded addresses.

    • +

  • tls_root_ca_bundle (str or None) – Proxy TLS root CA bundle which will be used to verify the proxy’s +certificates. Every certificate in the bundle is expected to be in +PEM format. This will be used if +ProxySettingsSource.CLUSTER_CONFIGURED is used for the +source, otherwise this will be ignored. This attribute was added in +vSphere API 7.0.3.00100. +If None only the vCenter certificates applied in VECS (VMware +Endpoint Certificate Store) will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management_client.ProxySettingsSource(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The settings can be inherited from the vCenter settings, so the cluster +settings will be synced. The settings can be applied directly on the +cluster level, or the cluster can be configured not to use a proxy. This +enumeration was added in vSphere API 7.0.3.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ProxySettingsSource instance.

+
+
+
+
+CLUSTER_CONFIGURED = ProxySettingsSource(string='CLUSTER_CONFIGURED')
+

Proxy settings will be configured at the cluster level. This class +attribute was added in vSphere API 7.0.3.00100.

+
+ +
+
+NONE = ProxySettingsSource(string='NONE')
+

No proxy settings will be applied to the cluster. This class attribute was +added in vSphere API 7.0.3.00100.

+
+ +
+
+VC_INHERITED = ProxySettingsSource(string='VC_INHERITED')
+

Proxy settings will be inherited from the vCenter settings. vCenter and +cluster settings will be kept in sync. This class attribute was added in +vSphere API 7.0.3.00100.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.SizingHint(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SizingHint class determines the configuration of Kubernetes API +server and the worker nodes. It also determines the default values +associated with the maximum number of pods and services. Use +ClusterSizeInfo.get() to get information associated with a +SizingHint.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SizingHint instance.

+
+
+
+
+LARGE = SizingHint(string='LARGE')
+

Cluster size of ‘large’.

+
+ +
+
+MEDIUM = SizingHint(string='MEDIUM')
+

Cluster size of ‘medium’.

+
+ +
+
+SMALL = SizingHint(string='SMALL')
+

Cluster size of ‘small’.

+
+ +
+
+TINY = SizingHint(string='TINY')
+

Cluster size of ‘tiny’.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management_client.SupervisorServices(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SupervisorServices class provides methods to manage a Supervisor +Service object. Supervisor services can be extensions to the vSphere +Supervisor and provide services to applications running in vSphere +Supervisor. They are often provided by 3rd party vendors. This class was +added in vSphere API 7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CarvelAppsCheckResult(supervisor_service=None, version=None, display_name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.CarvelAppsCheckResult class contains the +information of a Supervisor Service version that is retrieved from the +content in Carvel application package format as a result of the +SupervisorServices.check_content() method. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_service (str) – The identifier of the Supervisor Service. This attribute was added +in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – The identifier of the Supervisor Service version. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +

  • display_name (str) – A human readable name of the Supervisor Service version. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • description (str or None) – A human readable description of the Supervisor Service version. +This attribute was added in vSphere API 8.0.0.1. +If None, no description is available for the Supervisor Service +version.

    • +
+
+
+
+ +
+
+class CarvelCreateSpec(version_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.CarvelCreateSpec class provides a specification +required to create a Supervisor Service with a version from Carvel +application package format (Package and PackageMetadata resources should be +declared). This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

version_spec (com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CarvelCreateSpec) – Supervisor service version specification that provides the service +definitions for one Supervisor Service version. This attribute was +added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+class CheckResult(status=None, content_type=None, vsphere_apps_check_result=None, carvel_apps_check_result=None, warning_messages=None, error_messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.CheckResult class defines the result of the +validation checks on the content of a Supervisor Service version. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class ContentCheckSpec(content=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.ContentCheckSpec class provides a specification +required for validation checks on the content of a Supervisor Service +version. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

content (str or None) – The content of a Supervisor Service version, which shall be base64 +encoded. This attribute was added in vSphere API 7.0.3.0. +If None, the content shall be provided separately. In the current +release, this field is required, otherwise InvalidArgument will +be thrown.

+
+
+
+ +
+
+class CreateSpec(custom_spec=None, vsphere_spec=None, carvel_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.CreateSpec class provides a specification +required to create a Supervisor Service. Exactly one of +SupervisorServices.CreateSpec.custom_spec or +SupervisorServices.CreateSpec.vsphere_spec must be set. +This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • custom_spec (SupervisorServices.CustomCreateSpec or None) –

    The specification required to create a Supervisor Service with a +version from inline content that is based on a plain Kubernetes +YAML format.

    +

    . This attribute was added in vSphere API 7.0.3.0. +If set, the service will be created from a version based +on a plain Kubernetes YAML format.

    +

    • +

  • vsphere_spec (SupervisorServices.VsphereCreateSpec or None) –

    The specification required to create a Supervisor Service with a +version from inline content that is based on the vSphere +application service format.

    +

    . This attribute was added in vSphere API 7.0.3.0. +If set, the service will be created from a version based +on the vSphere application service format.

    +

    • +

  • carvel_spec (SupervisorServices.CarvelCreateSpec or None) –

    The specification required to create a Supervisor Service with a +version from inline content that is based on the Carvel application +package format.

    +

    . This attribute was added in vSphere API 8.0.0.1. +If set, the service will be created from a version based +on the Carvel application package format (Package and +PackageMetadata resources should be declared).

    +

    • +
+
+
+
+ +
+
+class CustomCreateSpec(supervisor_service=None, display_name=None, description=None, version_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.CustomCreateSpec class provides a specification +required to create a Supervisor Service with a version from a plain +Kubernetes YAML format. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_service (str) – The identifier of the Supervisor Service. This has DNS_LABEL +restrictions as specified in ` +<https://tools.ietf.org/html/rfc1123>`_. This must be an +alphanumeric (a-z and 0-9) string and with maximum length of 63 +characters and with the ‘-’ character allowed anywhere except the +first or last character. This identifier must be unique across all +Namespaces in this vCenter server. Additionally, the ID +‘namespaces’ is reserved and must not be used. This attribute was +added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • display_name (str) – A human readable name of the Supervisor Service. This attribute was +added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human readable description of the Supervisor Service. This +attribute was added in vSphere API 7.0.3.0. +If None, the Supervisor Service description will be empty.

    • +

  • version_spec (com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec) – Supervisor service version specification that provides the service +definition for one Supervisor Service version. This attribute was +added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class Info(display_name=None, state=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.Info class contains detailed information about a +Supervisor Service. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – The human readable name of the Supervisor Service. This attribute +was added in vSphere API 7.0.3.0.

    • +

  • state (SupervisorServices.State) – The current SupervisorServices.State of the Supervisor Service. +This attribute was added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human readable description of the Supervisor Service. This +attribute was added in vSphere API 7.0.3.0. +If None, no description is available for the Supervisor Service.

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SupervisorServices.State class defines the state of a Supervisor +Service. This enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+ACTIVATED = State(string='ACTIVATED')
+

The is the default state of a Supervisor Service upon creation. In this +state, at least one version of the Supervisor Service is activated. This +class attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+DEACTIVATED = State(string='DEACTIVATED')
+

The is the deactivated state of a Supervisor Service. In this state, all +existing versions of the Supervisor Service will be deactivated, and cannot +be activated. In addition to that, no new versions can be added to the +Supervisor Service. This class attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class Summary(supervisor_service=None, display_name=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.Summary class contains the basic information +about a Supervisor Service version. This class was added in vSphere API +7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_service (str) – The identifier of the Supervisor Service. This attribute was added +in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • display_name (str) – The human readable name of the Supervisor Service. This attribute +was added in vSphere API 7.0.3.0.

    • +

  • state (SupervisorServices.State) – The current SupervisorServices.State of the Supervisor Service. +This attribute was added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class UpdateSpec(display_name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.UpdateSpec class provides a specification +required to update a Supervisor Service. This class was added in vSphere +API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str or None) – A human readable name of the Supervisor Service. This attribute was +added in vSphere API 7.0.3.0. +If None, the display name of the service will not be modified.

    • +

  • description (str or None) – A human readable description of the Supervisor Service. This +attribute was added in vSphere API 7.0.3.0. +If None, the description of the service will not be modified.

    • +
+
+
+
+ +
+
+class ValidationStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SupervisorServices.ValidationStatus class defines the type of +status for validating content of a Supervisor Service version. This +enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ValidationStatus instance.

+
+
+
+
+INVALID = ValidationStatus(string='INVALID')
+

Indicates the content is invalid for a Supervisor Service version, in which +case the reasons can be found in errorMessages. This class attribute +was added in vSphere API 7.0.3.0.

+
+ +
+
+VALID = ValidationStatus(string='VALID')
+

Indicates the content is valid for a Supervisor Service version. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+VALID_WITH_WARNINGS = ValidationStatus(string='VALID_WITH_WARNINGS')
+

Indicates the content is valid for a Supervisor Service version, but the +content may contain information that should be reviewed closely and could +prevent the Supervisor Service version to be created successfully later, +which is explained in warningMessages. For example, the content may +specify a Supervisor Service version that already exists on this vCenter. +This class attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class VsphereAppsCheckResult(supervisor_service=None, version=None, display_name=None, description=None, eula=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.VsphereAppsCheckResult class contains the +information of a Supervisor Service version that is retrieved from the +content in vSphere application service format as a result of the +SupervisorServices.check_content() method. This class was added in +vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_service (str) – The identifier of the Supervisor Service. This attribute was added +in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – The identifier of the Supervisor Service version. This attribute +was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +

  • display_name (str) – A human readable name of the Supervisor Service version. This +attribute was added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human readable description of the Supervisor Service version. +This attribute was added in vSphere API 7.0.3.0. +If None, no description is available for the Supervisor Service +version.

    • +

  • eula (str or None) – The End User License Agreement (EULA) of the Supervisor Service +version. This attribute was added in vSphere API 7.0.3.0. +If None, no EULA is available for the Supervisor Service version.

    • +
+
+
+
+ +
+
+class VsphereCreateSpec(version_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupervisorServices.VsphereCreateSpec class provides a specification +required to create a Supervisor Service with a version from vSphere +application service format, which shall contain the service identifier, +display name and description information. This class was added in vSphere +API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

version_spec (com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec) – Supervisor service version specification that provides the service +definitions for one Supervisor Service version. This attribute was +added in vSphere API 7.0.3.0.

+
+
+
+ +
+
+activate(supervisor_service)
+

Activate a Supervisor Service. This method will change the +SupervisorServices.State of the supervisor service to in +ACTIVATED state, and activate all versions of the supervisor +service. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service is already in ACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service could not +be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+check_content(spec)
+

Perform validation checks on the content of a Supervisor Service +version defined in the spec. The method returns the validation +status and relevant Supervisor Service version information that are +available in the content. A custom format will always return a +VALID status. Only vSphere and Carvel packages can return multiple +validation statuses. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

spec (SupervisorServices.ContentCheckSpec) – Specification for the content to be checked.

+
+
Return type
+

SupervisorServices.CheckResult

+
+
Returns
+

A check result containing validation status and relevant Supervisor +Service version information from the provided content, if the +content is valid. In case of invalid content, it will return a list +of error messages.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the provided spec is invalid. For example, the provided +SupervisorServices.ContentCheckSpec.content is empty or not +base64 encoded.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the System.Read privilege.

+
+
+
+ +
+
+create(spec)
+

Create a Supervisor Service. If version specs are provided in the +spec, new Supervisor Service versions will be created as part of +the operation. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

spec (SupervisorServices.CreateSpec) – Specification for the Supervisor Service with version definition.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a Supervisor Service with the same identifier already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors or if an invalid name is specified. +For example, when the service is from a trusted provider, but no +signature is provided or it is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+deactivate(supervisor_service)
+

Deactivate a Supervisor Service. This method will change the +SupervisorServices.State of the supervisor service to +DEACTIVATED state, and deactivate all versions of the supervisor +service. Note that this method should be called before deleting the +Supervisor Service. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service is already in DEACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service could not +be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+delete(supervisor_service)
+

Delete a Supervisor Service. This method only deletes the Supervisor +Service from vCenter if the Supervisor Service is in DEACTIVATED +state, and all versions of the Supervisor Service are removed from +vCenter. Note that the deactivate method should be called to +deactivate the Supervisor Service before the Supervisor Service can be +deleted. This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service cannot be deleted in the current state, +e.g. a version of the Supervisor Service is not in DEACTIVATED +state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service could not +be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+get(supervisor_service)
+

Return the information for the specified Supervisor Service. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

+
+
Return type
+

SupervisorServices.Info

+
+
Returns
+

Information for the specified Supervisor Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service could not +be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the System.Read privilege.

+
+
+
+ +
+
+list()
+

Return the information about all Supervisor Services on this vCenter. +This method was added in vSphere API 7.0.3.0.

+
+
Return type
+

list of SupervisorServices.Summary

+
+
Returns
+

The list of summary of all Supervisor Services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the System.Read privilege.

+
+
+
+ +
+
+update(supervisor_service, spec)
+

Update a Supervisor Service. This method was added in vSphere API +7.0.3.0.

+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • spec (SupervisorServices.UpdateSpec) – Specification for the Supervisor Service metadata to be updated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors or if an invalid name is specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service could not +be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the SupervisorServices.Manage privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.Supervisors(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Supervisors service manages the lifecycle of the Supervisor. This +interface replaces the Clusters service. This class was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class EnableOnComputeClusterSpec(zone=None, name=None, control_plane=None, workloads=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Supervisors.EnableOnComputeClusterSpec class contains the +specification required to enable a Supervisor on a vSphere cluster.

+

The ability to add multiple workload networks at enablement has been +deprecated. Please use the Networks APIs to add additional +workload networks after the cluster has been enabled.. This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str or None) – Supervisors.EnableOnComputeClusterSpec.zone describes +consumption fault domain zone available to the Supervisor and its +workloads. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. +Zone will be created and associated with the cluster. If None, the +zone name will be generated based on the cluster managed object ID. +The zone can be managed with the zone api {\@link +#com.vmware.vcenter.consumption-domains.Zones}

    • +

  • name (str) – A Supervisors.EnableSpec.name is a user-friendly identifier +for this Supervisor. This attribute was added in vSphere API +8.0.0.1.

    • +

  • control_plane (com.vmware.vcenter.namespace_management.supervisors_client.ControlPlane) – Supervisors.EnableSpec.control_plane specifies +configuration for the Supervisor control plane. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • workloads (com.vmware.vcenter.namespace_management.supervisors_client.Workloads) – Supervisors.EnableSpec.workloads specifies configuration +for compute, network, and storage for workloads. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class EnableOnZonesSpec(zones=None, name=None, control_plane=None, workloads=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Supervisors.EnableOnZonesSpec class contains the specification +required to enable the Supervisor on a set of vSphere Zones.

+

The ability to add multiple workload networks at enablement has been +deprecated. Please use the Networks APIs to add additional +workload networks after the cluster has been enabled.. This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zones (list of str) – Supervisors.EnableOnZonesSpec.zones describe consumption +fault domain zones available to the Supervisor and its workloads. +Only one or three zones are supported. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • name (str) – A Supervisors.EnableSpec.name is a user-friendly identifier +for this Supervisor. This attribute was added in vSphere API +8.0.0.1.

    • +

  • control_plane (com.vmware.vcenter.namespace_management.supervisors_client.ControlPlane) – Supervisors.EnableSpec.control_plane specifies +configuration for the Supervisor control plane. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • workloads (com.vmware.vcenter.namespace_management.supervisors_client.Workloads) – Supervisors.EnableSpec.workloads specifies configuration +for compute, network, and storage for workloads. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class EnableSpec(name=None, control_plane=None, workloads=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Supervisors.EnableSpec class contains the specification required to +enable a Supervisor.

+

The ability to add multiple workload networks at enablement has been +deprecated. Please use the Networks APIs to add additional +workload networks after the cluster has been enabled.. This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+enable_on_compute_cluster(cluster, spec)
+

Enable the Supervisor on a single vSphere cluster. This operation sets +up the Kubernetes instance for the cluster along with worker nodes. A +{\@link #com.vmware.vcenter.consumption-domains.Zones} zone will +automatically be created if the specified cluster is not already +associated with a vSphere Zone.

+

To verify if the Supervisor is compatible with this vSphere cluster +use: ClusterCompatibility.list().

+

A Supervisor can be running on one or multiple vSphere Zones, and each +vSphere Zone is associated with one or more vSphere Clusters. If a +Supervisor running on the specified vSphere Cluster is running on +additional vSphere Clusters, this operation will apply to Supervisor +components running on the other vSphere Clusters in addition to the +specified vSphere Cluster.

+

To call this API on a Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors_client.Topology.get() +to get the vSphere Clusters associated with the given Supervisor. Any +cluster from the list returned can be used as the input of this API.. +This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster used to enable the Supervisor Cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Supervisors.EnableOnComputeClusterSpec) – Specification for configuring the Supervisor and Workloads.

    • +
+
+
Return type
+

str

+
+
Returns
+

ID of the Supervisor object being enabled. +The return value will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the cluster already has the Supervisor enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if resources/objects could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the specified cluster is not licensed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster is not supported for the Supervisor, the +cluster’s hosts do not have the required ESX version, or for any +other incompatibilities.

+
+
+
+ +
+
+enable_on_zones(spec)
+

Enable a Supervisor on a set of vSphere Zones. The cluster control +plane and its workloads will be eligible for placement across the +zones. Enabling on multiple zones enables fault tolerance for +applications deployed on more than one zone in case of a zone failure.

+

To verify if the Supervisor is compatible with the provided Zones use: +ClusterCompatibility.list().. This method was added in vSphere +API 8.0.0.1.

+
+
Parameters
+

spec (Supervisors.EnableOnZonesSpec) – Specification for configuring the Supervisor and Workloads.

+
+
Return type
+

str

+
+
Returns
+

ID of the Supervisor object being enabled. +The return value will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if one or more zones already host a another Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the provided zones could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the one or more zones are not licensed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the zones are not supported for the Supervisor, the zones’ hosts +do not have the required ESX version, or for any other +incompatibilities.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.SupportBundle(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The SupportBundle class provides methods to retrieve the cluster’s +Namespaces-related support bundle download location.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Location(url=None, wcp_support_bundle_token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupportBundle.Location class contains the URI location to download +the per-cluster support bundle from, as well as a token required (as a +header on the HTTP request) to get the bundle. The validity of the token is +5 minutes. After the token expires, any attempt to call the URI with said +token will fail.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • url (str) – Support Bundle Download URL.

    • +

  • wcp_support_bundle_token (SupportBundle.Token) – Information about the token required in the HTTP GET request to +generate the support bundle.

    • +
+
+
+
+ +
+
+class Token(token=None, expiry=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SupportBundle.Token class contains information about the token +required in the HTTP GET request to generate the support bundle.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • token (str) – A one-time, short-lived token required in the HTTP header of the +request to the url. This token needs to be passed in as a header +with the name “wcp-support-bundle-token”.

    • +

  • expiry (str) – Expiry time of the token

    • +
+
+
+
+ +
+
+create(cluster)
+

Returns the location SupportBundle.Location information for +downloading the Namespaces-related support bundle for the specified +cluster.

+

Retrieving a support bundle involves two steps:

+
    +

  • Step 1: Invoke method to provision a token and a URI.

    • +

  • Step 2: Make an HTTP GET request using URI and one time used token +returned in step 1 to generate the support bundle and return it.

    • +
+

There can only be one valid token per cluster at any given time. If +this method is invoked again for the same cluster identifier while a +token still valid, the API will return the same +SupportBundle.Location response.

+

The HTTP GET request will:

+
    +

  • return 401 (Not Authorized) if the download URL is recognized, but +the token is invalid.

    • +

  • otherwise return 200 (OK), mark the token used (invalidating it for +any future use), open a application/tar download stream for the client, +and start the bundle process. As part of its work, the API will +orchestrate support bundling on the worker nodes of a cluster. If a +failure occurs during the collection of support bundle from worker +node, the API will not abort the request, but will log a warning and +move on to processing other worker nodes’ bundles. The API will only +abort its operation if the content of the stream has been corrupted. +When the API has to abort its operation (and the response stream), it +will not provide any indication of failures to the client. The client +will need to verify validity of the resultant file based on the format +specified in the response’s Content-Disposition header.

    • +
+
+
Parameters
+

cluster (str) – Identifier of cluster for which the Namespaces-related support +bundle should be generated. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

SupportBundle.Location

+
+
Returns
+

the download location of the support bundle for the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified cluster is not registered on this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Global.Diagnostics privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.VirtualMachineClasses(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The VirtualMachineClasses class provides management methods for +customizable virtual machine classes. A virtual machine class represents a +policy and configuration resource which defines a set of attributes to be +used in the configuration of a virtual machine instance. This class was +added in vSphere API 7.0.2.00100.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfigStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

ConfigStatus represents the config status of the VM class. This enumeration +was added in vSphere API 7.0.2.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigStatus instance.

+
+
+
+
+READY = ConfigStatus(string='READY')
+

Indicates that the instance of the VirtualMachineClasses is ready to be +used. This class attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+REMOVING = ConfigStatus(string='REMOVING')
+

Indicates that the instance of the VirtualMachineClasses is being +deleted. At this state the VM class cannot be associated with new +Namespace. This class attribute was added in vSphere API 7.0.2.00100.

+
+ +
+ +
+
+class CreateSpec(id=None, cpu_count=None, cpu_reservation=None, memory_mb=None, memory_reservation=None, description=None, devices=None, instance_storage=None, config_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.CreateSpec class contains the specification +required to create a VM class object. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Identifier of the virtual machine class. This has DNS_LABEL +restrictions as specified in ` +<https://tools.ietf.org/html/rfc1123>`_. This must be an +alphanumeric (a-z and 0-9) string and with maximum length of 63 +characters and with the ‘-’ character allowed anywhere except the +first or last character. This name is unique in this vCenter +server. This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass.

    • +

  • cpu_count (long) – The number of CPUs configured for virtual machine of this class. +This attribute was added in vSphere API 7.0.2.00100.

    • +

  • cpu_reservation (long or None) –

    The percentage of total available CPUs reserved for a virtual +machine. We multiply this percentage by the minimum frequency +amongst all the cluster nodes to get the CPU reservation that is +specified to vSphere in MHz. This attribute was added in vSphere +API 7.0.2.00100. +If None, no CPU reservation is requested for the virtual machine.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0 +Use CPU allocation in +VirtualMachineClasses.CreateSpec.config_spec instead to +reserve CPUs for a virtual machine.

    +
    +

    • +

  • memory_mb (long) – The amount of memory in MB configured for virtual machine of this +class. This attribute was added in vSphere API 7.0.2.00100.

    • +

  • memory_reservation (long or None) –

    The percentage of available memory reserved for a virtual machine +of this class. Memory reservation must be set to 100% for VM class +with vGPU or Dynamic DirectPath I/O devices. This attribute was +added in vSphere API 7.0.2.00100. +If None, no memory reservation is requested for virtual machine.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0 +Use memory allocation in +VirtualMachineClasses.CreateSpec.config_spec instead to +reserve memory for a virtual machine.

    +
    +

    • +

  • description (str or None) – Description for the VM class. This attribute was added in vSphere +API 7.0.2.00100. +If None, no description is added to the VM class.

    • +

  • devices (VirtualMachineClasses.VirtualDevices or None) –

    Virtual devices that will be attached to the VMs created with this +class. This attribute was added in vSphere API 7.0.3.0. +If None, no Virtual device will be attached to the VMs created with +this class.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0 +Use device changes in +VirtualMachineClasses.CreateSpec.config_spec instead to +add vGPU and Dynamic DirectPath I/O virtual devices.

    +
    +

    • +

  • instance_storage (VirtualMachineClasses.InstanceStorage or None) – Instance storage that will be attached to the VMs created with this +class. This attribute was added in vSphere API 8.0.0.0. +If None, instance storage specification will not be created.

    • +

  • config_spec (vmware.vapi.struct.VapiStruct or None) – A VirtualMachineConfigSpec associated with the VM class. This +attribute was added in vSphere API 8.0.2.0. +If None, no config spec will be associated to the VM Class.

    • +
+
+
+
+ +
+
+class DynamicDirectPathIODevice(vendor_id=None, device_id=None, custom_label=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.DynamicDirectPathIODevice class contains the +configuration corresponding to a Dynamic DirectPath I/O device. This class +was added in vSphere API 7.0.3.0.

+
+

Deprecated since version vSphere: API 8.0.2.0 +Use device changes in VirtualMachineConfigSpec associated with the VM +class to add Dynamic DirectPath I/O devices.

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vendor_id (long) – The vendor ID of this device. This attribute was added in vSphere +API 7.0.3.0.

    • +

  • device_id (long) – The device ID of this device. This attribute was added in vSphere +API 7.0.3.0.

    • +

  • custom_label (str or None) – The custom label attached to this device. This attribute was added +in vSphere API 7.0.3.0. +If None, custom label is not used to identify the device.

    • +
+
+
+
+ +
+
+class Info(id=None, cpu_count=None, cpu_reservation=None, memory_mb=None, memory_reservation=None, description=None, namespaces=None, vms=None, config_status=None, messages=None, devices=None, instance_storage=None, config_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.Info class contains detailed information +about the virtual machine class. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – Identifier for the VM class. This attribute was added in vSphere +API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass.

    • +

  • cpu_count (long) – The number of CPUs configured for virtual machine of this class. +This attribute was added in vSphere API 7.0.2.00100.

    • +

  • cpu_reservation (long or None) –

    The percentage of total available CPUs reserved for a virtual +machine. We multiply this percentage by the minimum frequency +amongst all the cluster nodes to get the CPU reservation that is +specified to vSphere in MHz. This attribute was added in vSphere +API 7.0.2.00100. +If None, no CPU reservation is requested for the virtual machine.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0

    +
    +

    • +

  • memory_mb (long) – The amount of memory in MB configured for virtual machine of this +class. This attribute was added in vSphere API 7.0.2.00100.

    • +

  • memory_reservation (long or None) –

    The percentage of available memory reserved for a virtual machine +of this class. This attribute was added in vSphere API 7.0.2.00100. +If None, no memory reservation is requested for virtual machine.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0

    +
    +

    • +

  • description (str) – Description of the VM class. This attribute was added in vSphere +API 7.0.2.00100.

    • +

  • namespaces (set of str) – Set of Namespaces associated with this VM class. This attribute was +added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • vms (set of str) – Set of virtual machines deployed for VM class. This attribute was +added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: VirtualMachine.

    • +

  • config_status (VirtualMachineClasses.ConfigStatus) – Configstatus of VM class. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • messages (list of VirtualMachineClasses.Message) – Current set of messages associated with the object. This attribute +was added in vSphere API 7.0.2.00100.

    • +

  • devices (VirtualMachineClasses.VirtualDevices) –

    Virtual devices corresponding to the VM class. This attribute was +added in vSphere API 7.0.3.0. +This attribute is optional because it was added in a newer version +than its parent node.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0

    +
    +

    • +

  • instance_storage (VirtualMachineClasses.InstanceStorage or None) – Instance storage associated with the VM class. This attribute was +added in vSphere API 8.0.0.0. +If None, no instance storage is present.

    • +

  • config_spec (vmware.vapi.struct.VapiStruct or None) – A VirtualMachineConfigSpec associated with the VM class. This +attribute was added in vSphere API 8.0.2.0. +If None, a config spec is not used to configure this VM class.

    • +
+
+
+
+ +
+
+class InstanceStorage(policy=None, volumes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.InstanceStorage class encapsulates +information about storage policy and instance storage volumes. This class +was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Policy corresponding to the instance storage. To use VM class with +instance storage, this policy should also be associated with +Supervisor namespace. See +com.vmware.vcenter.namespaces.Instances.StorageSpec. This attribute +was added in vSphere API 8.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • volumes (list of VirtualMachineClasses.InstanceStorageVolume) – List of instance storage volumes. At least one volume is required +when configuring a VM class with instance storage. This attribute +was added in vSphere API 8.0.0.0.

    • +
+
+
+
+ +
+
+class InstanceStorageVolume(size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.InstanceStorageVolume class contains the +specification required to configure instance storage for virtual machines. +An admin can create VM classes with instance storage volumes and assign +them to Supervisor namespaces for consumption. These VM classes can be used +to create virtual machines that have instance storage volumes attached as +disks. The generated instance volumes are placed on vSan direct datastores. +This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

size (long) – The size of instance storage volume in mebibytes (MiB) available +for the virtual machine of this class. This attribute was added in +vSphere API 8.0.0.0.

+
+
+
+ +
+
+class Message(severity=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.Message class contains the information about +the object configuration. This class was added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class MessageSeverity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The VirtualMachineClasses.Message.MessageSeverity class represents the +severity of the message. This enumeration was added in vSphere API +7.0.2.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MessageSeverity instance.

+
+
+
+
+ERROR = MessageSeverity(string='ERROR')
+

Error message. This is accompanied by vCenter event and/or alarm. This +class attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+INFO = MessageSeverity(string='INFO')
+

Informational message. This may be accompanied by vCenter event. This class +attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+WARNING = MessageSeverity(string='WARNING')
+

Warning message. This may be accompanied by vCenter event. This class +attribute was added in vSphere API 7.0.2.00100.

+
+ +
+ +
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.namespace_management.VirtualMachineClass'
+

The resource type for VM class. This class attribute was added in vSphere API +7.0.2.00100.

+
+ +
+
+class UpdateSpec(cpu_count=None, cpu_reservation=None, memory_mb=None, memory_reservation=None, description=None, devices=None, instance_storage=None, config_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.UpdateSpec class contains the specification +required to update a VM class object. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu_count (long or None) – The number of CPUs configured for virtual machine of this class. +This attribute was added in vSphere API 7.0.2.00100. +If None the current value the will not be modified.

    • +

  • cpu_reservation (long or None) –

    The percentage of total available CPUs reserved for a virtual +machine. We multiply this percentage by the minimum frequency +amongst all the cluster nodes to get the CPU reservation that is +specified to vSphere in MHz. This attribute was added in vSphere +API 7.0.2.00100. +If None, no CPU reservation is requested for the virtual machine.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0 +Use CPU allocation in +VirtualMachineClasses.UpdateSpec.config_spec instead to +reserve CPUs for a virtual machine.

    +
    +

    • +

  • memory_mb (long or None) – The amount of memory in MB configured for virtual machine of this +class. This attribute was added in vSphere API 7.0.2.00100. +If None the current value the will not be modified.

    • +

  • memory_reservation (long or None) –

    The percentage of available memory reserved for a virtual machine +of this class. Memory reservation must be set to 100% for VM class +with vGPU or Dynamic DirectPath I/O devices. This attribute was +added in vSphere API 7.0.2.00100. +If None, no memory reservation is requested for virtual machine.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0 +Use memory allocation in +VirtualMachineClasses.UpdateSpec.config_spec instead to +reserve memory for a virtual machine.

    +
    +

    • +

  • description (str or None) – Description for the VM class. This attribute was added in vSphere +API 7.0.2.00100. +If None, description is not updated.

    • +

  • devices (VirtualMachineClasses.VirtualDevices or None) –

    Virtual devices corresponding to the VM class. This attribute was +added in vSphere API 7.0.3.0. +If None, virtual devices will not be updated.

    +
    +

    Deprecated since version vSphere: API 8.0.2.0 +Use device changes in +VirtualMachineClasses.UpdateSpec.config_spec instead to +add vGPU and Dynamic DirectPath I/O virtual devices.

    +
    +

    • +

  • instance_storage (VirtualMachineClasses.InstanceStorage or None) – Instance storage associated with the VM class. This attribute was +added in vSphere API 8.0.0.0. +If None, instance storage specification will not be updated.

    • +

  • config_spec (vmware.vapi.struct.VapiStruct or None) – A VirtualMachineConfigSpec associated with the VM class. This +attribute was added in vSphere API 8.0.2.0. +If None, the config spec will not be updated.

    • +
+
+
+
+ +
+
+class VGPUDevice(profile_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.VGPUDevice class contains the configuration +corresponding to a vGPU device. This class was added in vSphere API +7.0.3.0.

+
+

Deprecated since version vSphere: API 8.0.2.0 +Use device changes in VirtualMachineConfigSpec associated with the VM +class to add vGPU devices.

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

profile_name (str) – Profile name corresponding to the device. This attribute was added +in vSphere API 7.0.3.0.

+
+
+
+ +
+
+class VirtualDevices(vgpu_devices=None, dynamic_direct_path_io_devices=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VirtualMachineClasses.VirtualDevices class contains information +about the virtual devices associated with a VM class. This class was added +in vSphere API 7.0.3.0.

+
+

Deprecated since version vSphere: API 8.0.2.0 +Use device changes in VirtualMachineConfigSpec associated with the VM +class to add vGPU and Dynamic DirectPath I/O virtual devices.

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vgpu_devices (list of VirtualMachineClasses.VGPUDevice or None) – List of vGPU devices. This attribute was added in vSphere API +7.0.3.0. +If None, no vGPU devices are present.

    • +

  • dynamic_direct_path_io_devices (list of VirtualMachineClasses.DynamicDirectPathIODevice or None) – List of Dynamic DirectPath I/O devices. This attribute was added in +vSphere API 7.0.3.0. +If None, no Dynamic DirectPath I/O devices are present.

    • +
+
+
+
+ +
+
+create(spec)
+

Create a VM class object. This method was added in vSphere API +7.0.2.00100.

+
+
Parameters
+

spec (VirtualMachineClasses.CreateSpec) – Information about the VM class object to be created.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a VM class by the name as specified in the spec already +exists in the vCenter inventory.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the input {\@param.spec.instanceStorage.policy} refers to an +invalid storage policy or if the input spec includes settings +that are out of acceptable bounds or a combination of settings that +are not internally consistent with the input spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have VirtualMachineClasses.Manage privilege.

+
+
+
+ +
+
+delete(vm_class)
+

Delete the VM class object. This method was added in vSphere API +7.0.2.00100.

+
+
Parameters
+

vm_class (str) – Identifier for the VM class. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +- TBD

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +VM class could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have VirtualMachineClasses.Manage privilege.

+
+
+
+ +
+
+get(vm_class)
+

Return information about a VM class. This method was added in vSphere +API 7.0.2.00100.

+
+
Parameters
+

vm_class (str) – Identifier for the VM class. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass.

+
+
Return type
+

VirtualMachineClasses.Info

+
+
Returns
+

Information about the specified VM class.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if VM class can not be found in the vCenter inventory.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list()
+

Return information about all VirtualMachine classes. This method was +added in vSphere API 7.0.2.00100.

+
+
Return type
+

list of VirtualMachineClasses.Info

+
+
Returns
+

List of information about all VirtualMachine classes

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+update(vm_class, spec)
+

Update the configuration of the VM class object. This method was added +in vSphere API 7.0.2.00100.

+
+
Parameters
+
    +

  • vm_class (str) – Identifier for the VM class. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass.

    • +

  • spec (VirtualMachineClasses.UpdateSpec) – Information about the VM class object to be updated.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a VM class by the name as specified in the spec already +exists in the vCenter inventory.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the input {\@param.spec.instanceStorage.policy} refers to an +invalid storage policy or if the input spec includes settings +that are out of acceptable bounds or a combination of settings that +are not internally consistent with the input spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if or the vm_class cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have VirtualMachineClasses.Manage privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management_client.WorkloadsStorageConfig(cloud_native_file_volume=None, ephemeral_storage_policy=None, image_storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

WorkloadsStorageConfig class describes how vSphere and Kubernetes will +persist images and volumes to disk. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cloud_native_file_volume (CNSFileConfig or None) – WorkloadsStorageConfig.cloud_native_file_volume specifies +the Cloud Native Storage file volume support on the Supervisor. +This feature provides ReadWriteMany container volumes support. +This attribute was added in vSphere API 8.0.0.1. +If None, file volume support will not be enabled on the Supervisor.

    • +

  • ephemeral_storage_policy (str or None) – WorkloadsStorageConfig.ephemeral_storage_policy identifies +the storage policy associated with ephemeral disks of all the +Kubernetes PodVMs in the cluster. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +If None during cluster enablement, the ephemeral storage policy +will be defaulted to the configured +com.vmware.vcenter.namespace_management.supervisors_client.ControlPlane.storage_policy.

    • +

  • image_storage_policy (str or None) – The WorkloadsStorageConfig.image_storage_policy class +contains the specification required to configure storage used for +PodVM container images. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +If None, the image storage policy will be set to the specified +WorkloadsStorageConfig.ephemeral_storage_policy if +provided. This field will inherit any defaults for ephemeral +storage policy set by the system.

    • +
+
+
+
+ +
+
+

com.vmware.vcenter.namespaces_client module

+

The com.vmware.vcenter.namespaces_client module provides classes for +managing namespaces related methods.

+
+
+class com.vmware.vcenter.namespaces_client.Access(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Access class provides methods to manage access control of subjects +on namespaces.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(role=None, identity_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Access.CreateSpec class contains the specification required to +create access control on the namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • role (Access.Role) – Role to be assigned.

    • +

  • identity_provider (str or None) – UUID of an external identity provider for the user, if any. Use +this field if the user is coming from an external identity provider +configured via the +com.vmware.vcenter.namespace_management.supervisors.identity.Providers +service. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. +If unset, vCenter Single Sign-On will be used as the identity +provider.

    • +
+
+
+
+ +
+
+class Info(role=None, identity_provider=None, inherited=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Access.Info class contains the information about the access control +of the subject on given domain on the namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • role (Access.Role) – Role of the subject on the namespace.

    • +

  • identity_provider (str or None) – UUID of an external identity provider for the user, if any. Use +this field if the user is coming from an external identity provider +configured via the +com.vmware.vcenter.namespace_management.supervisors.identity.Providers +service. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. +If unset, vCenter Single Sign-On will be used as the identity +provider.

    • +

  • inherited (bool) – Flag to indicate if the Access.Info.role is direct or +inherited. The value is set to true if the +Access.Info.role is inherited from group membership. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class Role(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Access.Role class lists the default roles which can be associated +with a subject on a domain on the namespace.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Role instance.

+
+
+
+
+EDIT = Role(string='EDIT')
+

This role allows modification of the namespace.

+
+ +
+
+OWNER = Role(string='OWNER')
+

This role allows modification and deletion of the namespace. This class +attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+VIEW = Role(string='VIEW')
+

This is a read-only role on the namespace.

+
+ +
+ +
+
+class SetSpec(role=None, identity_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Access.SetSpec class contains the specification required to set new +access control on the namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • role (Access.Role) – Role to be assigned.

    • +

  • identity_provider (str or None) – UUID of an external identity provider for the user, if any. Use +this field if the user is coming from an external identity provider +configured via the +com.vmware.vcenter.namespace_management.supervisors.identity.Providers +service. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. +If unset, vCenter Single Sign-On will be used as the identity +provider.

    • +
+
+
+
+ +
+
+class SubjectType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Access.SubjectType class lists the types of subjects who can be +associated with a Access.Role on the namespace.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SubjectType instance.

+
+
+
+
+GROUP = SubjectType(string='GROUP')
+

Group of users.

+
+ +
+
+USER = SubjectType(string='USER')
+

Single user.

+
+ +
+ +
+
+create(namespace, domain, subject, type, spec)
+

Set up access control for the subject on given domain on the namespace.

+
+
Parameters
+
    +

  • namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • domain (str) – The domain of the subject.

    • +

  • subject (str) – The principal for this operation.

    • +

  • type (Access.SubjectType) – The type of subject (USER or GROUP).

    • +

  • spec (Access.CreateSpec) – Information about the access control to be created.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the specified principal on given domain is already associated +with a role on the namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the namespace is marked for deletion or the associated cluster +is being disabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors or if an invalid type is +specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified principal on given domain is not associated with +the namespace, or when the user or group does not come from vSphere +SSO and the OWNER role is being granted.

+
+
+
+ +
+
+delete(namespace, domain, subject, type)
+

Remove access control of the subject on given domain from the +namespace.

+
+
Parameters
+
    +

  • namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • domain (str) – The domain of the subject.

    • +

  • subject (str) – The principal for this operation.

    • +

  • type (Access.SubjectType) – The type of subject (USER or GROUP).

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the namespace is marked for deletion or the associated cluster +is being disabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified principal on given domain is not associated with +the namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
+
+ +
+
+get(namespace, domain, subject, type)
+

Get the information about the access control of the subject on given +domain on the namespace.

+
+
Parameters
+
    +

  • namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • domain (str) – The domain of the subject.

    • +

  • subject (str) – The principal for this operation.

    • +

  • type (Access.SubjectType) – The type of subject (USER or GROUP).

    • +
+
+
Return type
+

Access.Info

+
+
Returns
+

Information about the subject including the type and the role on +the namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified principal on given domain is not associated with +the namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+set(namespace, domain, subject, type, spec)
+

Set new access control on the namespace for the subject on given +domain.

+
+
Parameters
+
    +

  • namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • domain (str) – The domain of the subject.

    • +

  • subject (str) – The principal for this operation.

    • +

  • type (Access.SubjectType) – The type of subject (USER or GROUP).

    • +

  • spec (Access.SetSpec) – Information about the new access control to be assigned.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the namespace is marked for deletion or the associated cluster +is being disabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace cannot be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified principal on given domain is not associated with +the namespace, or when changing to OWNER permission for a user or +group coming from an external identity provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors or if an invalid type is +specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespaces_client.Instances(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Instances class provides methods to create and delete a namespace +object. In this version, an Instance is an abstraction around a Kubernetes +namespace.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Access(subject_type=None, subject=None, domain=None, role=None, identity_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Access class contains the access control information for +a subject on a namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • subject_type (Access.SubjectType) – Type of the subject.

    • +

  • subject (str) – Name of the subject.

    • +

  • domain (str) – Domain of the subject.

    • +

  • role (Access.Role) – Role of the subject on the namespace instance.

    • +

  • identity_provider (str or None) – UUID of an external identity provider for the user, if any. Use +this field if the user is coming from an external identity provider +configured via the +com.vmware.vcenter.namespace_management.supervisors.identity.Providers +service. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. +If unset, vCenter Single Sign-On will be used as the identity +provider.

    • +
+
+
+
+ +
+
+class ConfigStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Instances.ConfigStatus class describes the status of reaching the +desired state configuration for the namespace.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigStatus instance.

+
+
+
+
+CONFIGURING = ConfigStatus(string='CONFIGURING')
+

The configuration is being applied to the namespace.

+
+ +
+
+ERROR = ConfigStatus(string='ERROR')
+

Failed to apply the configuration to the namespace, user intervention +needed.

+
+ +
+
+REMOVING = ConfigStatus(string='REMOVING')
+

The configuration is being removed and namespace is being deleted.

+
+ +
+
+RUNNING = ConfigStatus(string='RUNNING')
+

The namespace is configured correctly.

+
+ +
+ +
+
+class ContentLibrarySpec(content_library=None, writable=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.ContentLibrarySpec class contains the specification +required to configure Content Libraries in the VM Image Service. This class +was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • content_library (str) – Content Library ID used by the VM Image Service. The Content +Library specified should exist in vSphere inventory. This attribute +was added in vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

    • +

  • writable (bool or None) –

    Flag to indicate if the Content Library is writable. When +set to true, users with Access.Info.role of +type OWNER or EDIT on a Supervisor namespace can add or delete +Content Library items in vSphere from this Supervisor namespace. A +subscribed Content Library is not allowed to be marked as writable.

    +

    An InvalidArgument error will be thrown from +Instances.create() method, Instances.update() method +and Instances.set() method if a subscribed Content Library +has the writable flag set to true.. This attribute was +added in vSphere API 8.0.2.0. +If None, the value defaults to false and the Content Library is +read-only to users.

    +

    • +
+
+
+
+ +
+
+class CreateSpec(cluster=None, namespace=None, description=None, resource_spec=None, access_list=None, storage_specs=None, networks=None, vm_service_spec=None, content_libraries=None, creator=None, namespace_network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.CreateSpec class contains the specification required to +set up a namespace on a single vSphere cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster on which the namespace is being created. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • namespace (str) – Identifier of the namespace. This has DNS_LABEL restrictions as +specified in ` <https://tools.ietf.org/html/rfc1123>`_. This must +be an alphanumeric (a-z and 0-9) string and with maximum length of +63 characters and with the ‘-’ character allowed anywhere except +the first or last character. This name is unique across all +Namespaces in this vCenter server. In this version, this maps to +the name of a Kubernetes namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • description (str or None) – Description for the namespace. +If None, no description is added to the namespace.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quota on the namespace. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1. +If None, no resource limits will be set on the namespace.

    • +

  • access_list (list of Instances.Access or None) – Access controls associated with the namespace. +If None, only users with Administrator role can access the +namespace.

    • +

  • storage_specs (list of Instances.StorageSpec or None) – Storage associated with the namespace. +If None, storage policies will not be associated with the namespace +which will prevent users from being able to provision pods with +persistent storage on the namespace. Users will be able to +provision pods which use local storage.

    • +

  • networks (list of str or None) –

    vSphere Namespaces network objects to be associated with the +namespace. The values of this list need to reference names of +pre-existing +com.vmware.vcenter.namespace_management.Networks.Info classs. +This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +The field must be left None if the cluster hosting the namespace +uses NSXT_CONTAINER_PLUGIN or NSXT_VPC as the network provider, +since the network(s) for this namespace will be managed on NSX-T.

    +

    When using NSXT_CONTAINER_PLUGIN as network provider, a new network +dedicated to the namespace will be created as part of namespace +creation to override cluster network configs if +Instances.NsxNetworkCreateSpec is set.

    +

    If the field is None when the cluster hosting the namespace uses +VSPHERE_NETWORK as its network provider, the namespace will +automatically be associated with the cluster’s Supervisor Primary +Workload Network. The field currently accepts at most only 1 +vSphere Namespaces network object reference.

    +

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – VM Service specification associated with the namespace. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) –

    List of Content Libraries used by the VM Image Service. This list +refers to existing Content Libraries in vSphere inventory.

    +

    The Content Libraries specified in {VMServiceSpec#contentLibraries} +will also be used by the VM Image Service but will be read-only by +default to users.

    +

    If the same Content Library is present both here and in +{VMServiceSpec#contentLibraries}, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings here are honored.

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +If None, no additional Content Libraries will be configured for the +VM Image Service except for the Content Libraries specified in +{VMServiceSpec#contentLibraries}.

    +

    • +

  • creator (Instances.Principal or None) – Creator of the namespace. Namespace self-service uses this field to +populate the user who created this namespace. This attribute was +added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • namespace_network (Instances.NetworkCreateSpec or None) – This field that accepts parameters to define a vSphere Namespace +Network object that will automatically be associated with this +Namespace. Networks created in this operation will be given an +autogenerated ID and cannot be referenced by other Namespaces. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class CreateSpecV2(supervisor=None, namespace=None, description=None, resource_spec=None, access_list=None, storage_specs=None, networks=None, vm_service_spec=None, content_libraries=None, creator=None, namespace_network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.CreateSpecV2 class contains the specification required to +set up a namespace on a Supervisor cluster. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the sSupervisor hosting the namespace. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • namespace (str) – Identifier of the namespace. This has DNS_LABEL restrictions as +specified in ` <https://tools.ietf.org/html/rfc1123>`_. This must +be an alphanumeric (a-z and 0-9) string and with maximum length of +63 characters and with the ‘-’ character allowed anywhere except +the first or last character. This name is unique across all +Namespaces in this vCenter server. In this version, this maps to +the name of a Kubernetes namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • description (str or None) – Description for the namespace. +If None, no description is added to the namespace.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quota on the namespace. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1. +If None, no resource limits will be set on the namespace.

    • +

  • access_list (list of Instances.Access or None) – Access controls associated with the namespace. +If None, only users with Administrator role can access the +namespace.

    • +

  • storage_specs (list of Instances.StorageSpec or None) – Storage associated with the namespace. +If None, storage policies will not be associated with the namespace +which will prevent users from being able to provision pods with +persistent storage on the namespace. Users will be able to +provision pods which use local storage.

    • +

  • networks (list of str or None) –

    vSphere Namespaces network objects to be associated with the +namespace. The values of this list need to reference names of +pre-existing +com.vmware.vcenter.namespace_management.Networks.Info classs. +This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +The field must be left None if the cluster hosting the namespace +uses NSXT_CONTAINER_PLUGIN or NSXT_VPC as the network provider, +since the network(s) for this namespace will be managed on NSX-T.

    +

    When using NSXT_CONTAINER_PLUGIN as network provider, a new network +dedicated to the namespace will be created as part of namespace +creation to override cluster network configs if +Instances.NsxNetworkCreateSpec is set.

    +

    If the field is None when the cluster hosting the namespace uses +VSPHERE_NETWORK as its network provider, the namespace will +automatically be associated with the cluster’s Supervisor Primary +Workload Network. The field currently accepts at most only 1 +vSphere Namespaces network object reference.

    +

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – VM Service specification associated with the namespace. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) –

    List of Content Libraries used by the VM Image Service. This list +refers to existing Content Libraries in vSphere inventory.

    +

    The Content Libraries specified in {VMServiceSpec#contentLibraries} +will also be used by the VM Image Service but will be read-only by +default to users.

    +

    If the same Content Library is present both here and in +{VMServiceSpec#contentLibraries}, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings here are honored.

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +If None, no additional Content Libraries will be configured for the +VM Image Service except for the Content Libraries specified in +{VMServiceSpec#contentLibraries}.

    +

    • +

  • creator (Instances.Principal or None) – Creator of the namespace. Namespace self-service uses this field to +populate the user who created this namespace. This attribute was +added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • namespace_network (Instances.NetworkCreateSpec or None) – This field that accepts parameters to define a vSphere Namespace +Network object that will automatically be associated with this +Namespace. Networks created in this operation will be given an +autogenerated ID and cannot be referenced by other Namespaces. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class Info(cluster=None, config_status=None, messages=None, stats=None, description=None, resource_spec=None, access_list=None, storage_specs=None, networks=None, vm_service_spec=None, content_libraries=None, creator=None, self_service_namespace=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Info class contains the detailed information about the +namespace on a single vSphere cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the vSphere cluster hosting the namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • config_status (Instances.ConfigStatus) – Current setting for Instances.ConfigStatus.

    • +

  • messages (list of Instances.Message) – Current set of messages associated with the object.

    • +

  • stats (Instances.Stats) – Basic runtime statistics for the namespace.

    • +

  • description (str) – Description of the namespace.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Quotas on the namespace resources. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for the type of the value for this field. +If None, no resource constraints are associated with the namespace.

    • +

  • access_list (list of Instances.Access) – Access controls associated with the namespace.

    • +

  • storage_specs (list of Instances.StorageSpec) – Storage associated with the namespace.

    • +

  • networks (list of str or None) – vSphere Networks associated with the namespace. This attribute was +added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +This field is None if the cluster hosting this namespace uses +NSXT_CONTAINER_PLUGIN or NSXT_VPC as its network provider.

    • +

  • vm_service_spec (Instances.VMServiceSpec) – VM Service specification associated with the namespace. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) –

    List of Content Libraries used by the VM Image Service. This list +refers to existing Content Libraries in vSphere inventory.

    +

    The Content Libraries specified in {VMServiceSpec#contentLibraries} +will also be included in this list but will be read-only by default +to users.

    +

    If the same Content Library is present both here and in +{VMServiceSpec#contentLibraries}, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings here are honored.

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +If None, no Content Libraries are configured for the VM Image +Service.

    +

    • +

  • creator (Instances.Principal or None) – Creator of the namespace. Namespace self-service uses this field to +populate the user who created this namespace. This attribute was +added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • self_service_namespace (bool or None) – Flag to indicate the self service namespace. This attribute was +added in vSphere API 7.0.2.00100. +If None, the namespace is not marked as self service namespace.

    • +
+
+
+
+ +
+
+class InfoV2(supervisor=None, config_status=None, messages=None, stats=None, description=None, resource_spec=None, access_list=None, storage_specs=None, networks=None, vm_service_spec=None, content_libraries=None, creator=None, self_service_namespace=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.InfoV2 class contains the detailed information about the +namespace on a Supervisor. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor hosting the namespace. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • config_status (Instances.ConfigStatus) – Current setting for Instances.ConfigStatus.

    • +

  • messages (list of Instances.Message) – Current set of messages associated with the object.

    • +

  • stats (Instances.Stats) – Basic runtime statistics for the namespace.

    • +

  • description (str) – Description of the namespace.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Quotas on the namespace resources. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for the type of the value for this field. +If None, no resource constraints are associated with the namespace.

    • +

  • access_list (list of Instances.Access) – Access controls associated with the namespace.

    • +

  • storage_specs (list of Instances.StorageSpec) – Storage associated with the namespace.

    • +

  • networks (list of str or None) – vSphere Networks associated with the namespace. This attribute was +added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +This field is None if the cluster hosting this namespace uses +NSXT_CONTAINER_PLUGIN or NSXT_VPC as its network provider.

    • +

  • vm_service_spec (Instances.VMServiceSpec) – VM Service specification associated with the namespace. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) –

    List of Content Libraries used by the VM Image Service. This list +refers to existing Content Libraries in vSphere inventory.

    +

    The Content Libraries specified in {VMServiceSpec#contentLibraries} +will also be included in this list but will be read-only by default +to users.

    +

    If the same Content Library is present both here and in +{VMServiceSpec#contentLibraries}, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings here are honored.

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +If None, no Content Libraries are configured for the VM Image +Service.

    +

    • +

  • creator (Instances.Principal or None) – Creator of the namespace. Namespace self-service uses this field to +populate the user who created this namespace. This attribute was +added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • self_service_namespace (bool or None) – Flag to indicate the self service namespace. This attribute was +added in vSphere API 7.0.2.00100. +If None, the namespace is not marked as self service namespace.

    • +
+
+
+
+ +
+
+class Ipv4Cidr(address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The specification for representing CIDR notation of IP range. This class +was added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – The IPv4 address. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • prefix (long) – The CIDR prefix. This attribute was added in vSphere API +7.0.2.00100.

    • +
+
+
+
+ +
+
+class LoadBalancerSize(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Instances.LoadBalancerSize enumerates the kinds of load balancer +sizes supported by NSX. Small load balancer can host 10 to 20 virtual +servers depending on NSX-T version. Medium load balancer can host 100 +virtual servers. Large load balancer can host 1000 virtual servers. This +enumeration was added in vSphere API 7.0.2.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LoadBalancerSize instance.

+
+
+
+
+LARGE = LoadBalancerSize(string='LARGE')
+

Load balancer size of ‘large’. This class attribute was added in vSphere +API 7.0.2.00100.

+
+ +
+
+MEDIUM = LoadBalancerSize(string='MEDIUM')
+

Load balancer size of ‘medium’. This class attribute was added in vSphere +API 7.0.2.00100.

+
+ +
+
+SMALL = LoadBalancerSize(string='SMALL')
+

Load balancer size of ‘small’. This class attribute was added in vSphere +API 7.0.2.00100.

+
+ +
+ +
+
+class Message(severity=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Message class contains the information about the object +configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class MessageSeverity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Instances.Message.MessageSeverity class represents the severity of +the message.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MessageSeverity instance.

+
+
+
+
+ERROR = MessageSeverity(string='ERROR')
+

Error message. This is accompanied by vCenter event and/or alarm.

+
+ +
+
+INFO = MessageSeverity(string='INFO')
+

Informational message. This may be accompanied by vCenter event.

+
+ +
+
+WARNING = MessageSeverity(string='WARNING')
+

Warning message. This may be accompanied by vCenter event.

+
+ +
+ +
+ +
+
+class NetworkCreateSpec(network_provider=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.NetworkCreateSpec class contains the specification +required to create a vSphere Namespaces network object. This class was +added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class NetworkProvider(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Identifies the network plugin that networking functionalities for this +vSphere Namespace. This enumeration was added in vSphere API 7.0.2.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkProvider instance.

+
+
+
+
+NSXT_CONTAINER_PLUGIN = NetworkProvider(string='NSXT_CONTAINER_PLUGIN')
+

NSX-T Container Plugin. This class attribute was added in vSphere API +7.0.2.00100.

+
+ +
+
+VSPHERE_NETWORK = NetworkProvider(string='VSPHERE_NETWORK')
+

vSphere Networking. This class attribute was added in vSphere API +7.0.2.00100.

+
+ +
+ +
+
+class NsxNetworkCreateSpec(namespace_network_cidrs=None, ingress_cidrs=None, egress_cidrs=None, nsx_tier0_gateway=None, subnet_prefix_length=None, routed_mode=None, load_balancer_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.NsxNetworkCreateSpec class describes the configuration +specification of a NSXT-backed Namespaces Network configuration. This class +was added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace_network_cidrs (list of Instances.Ipv4Cidr or None) – CIDR blocks from which Kubernetes allocates IP addresss for all +workloads that attach to the namespace, including PodVMs, TKGS and +VM Service VMs. This range should not overlap with those in +Instances.NsxNetworkCreateSpec.ingress_cidrs, +Instances.NsxNetworkCreateSpec.egress_cidrs, or other +services running in the datacenter. This attribute was added in +vSphere API 7.0.2.00100. +This field is required when +Instances.NsxNetworkCreateSpec.nsx_tier0_gateway or any of +Instances.NsxNetworkCreateSpec.ingress_cidrs, +Instances.NsxNetworkCreateSpec.egress_cidrs are specified. +An update operation only allows for addition of new CIDR blocks to +the existing list.

    • +

  • ingress_cidrs (list of Instances.Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses for Kubernetes +Ingresses and Kubernetes Services of type LoadBalancer. These +ranges should not overlap with those in +Instances.NsxNetworkCreateSpec.namespace_network_cidrs, +Instances.NsxNetworkCreateSpec.egress_cidrs, or other +services running in the datacenter. This attribute was added in +vSphere API 7.0.2.00100. +This field is required when +Instances.NsxNetworkCreateSpec.nsx_tier0_gateway or any of +Instances.NsxNetworkCreateSpec.namespace_network_cidrs, +Instances.NsxNetworkCreateSpec.egress_cidrs are specified. +An update operation only allows for addition of new CIDR blocks to +the existing list.

    • +

  • egress_cidrs (list of Instances.Ipv4Cidr or None) – CIDR blocks from which NSX assigns IP addresses used for performing +SNAT from container IPs to external IPs. These ranges should not +overlap with those in +Instances.NsxNetworkCreateSpec.namespace_network_cidrs, +Instances.NsxNetworkCreateSpec.ingress_cidrs, or other +services running in the datacenter. This attribute was added in +vSphere API 7.0.2.00100. +This field is required when +Instances.NsxNetworkCreateSpec.routed_mode is set to False +and Instances.NsxNetworkCreateSpec.nsx_tier0_gateway or any +of Instances.NsxNetworkCreateSpec.namespace_network_cidrs, +Instances.NsxNetworkCreateSpec.ingress_cidrs is specified. +When Instances.NsxNetworkCreateSpec.routed_mode is set to +True, this field is not allowed. An update operation only allows +for addition of new CIDR blocks to the existing list.

    • +

  • nsx_tier0_gateway (str or None) – NSX Tier0 Gateway used for this namespace. This field does not +allow update once applied. This attribute was added in vSphere API +7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway. +If None, cluster level settings specified in +com.vmware.vcenter.namespace_management.Clusters.NCPClusterNetworkInfo#nsxTier0Gateway +will be applied.

    • +

  • subnet_prefix_length (long or None) – Size of the subnet reserved for namespace segments. This attribute +was added in vSphere API 7.0.2.00100. +If None, cluster level settings specified in +com.vmware.vcenter.namespace_management.Clusters.NCPClusterNetworkInfo#namespaceSubnetPrefix +will be applied.

    • +

  • routed_mode (bool or None) – Routed mode for this namespace. When set to True, the traffic in +the namespace is not NATed. This attribute was added in vSphere API +7.0.2.00100. +If None, defaults to False. When this field is set to True, +Instances.NsxNetworkCreateSpec.egress_cidrs is not allowed. +This field does not allow update once applied.

    • +

  • load_balancer_size (Instances.LoadBalancerSize or None) – The size of the NSX Load Balancer used by the namespace. This field +does not allow update once applied. This attribute was added in +vSphere API 7.0.2.00100. +If None, defaults to Instances.LoadBalancerSize.SMALL.

    • +
+
+
+
+ +
+
+class Principal(subject=None, domain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Principal class contains the information about the +creator of namespace. This class was added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • subject (str) – Name of the subject. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • domain (str) – Domain of the subject. This attribute was added in vSphere API +7.0.2.00100.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.namespaces.Instance'
+

The resource type for namespace.

+
+ +
+
+class SetSpec(description=None, resource_spec=None, access_list=None, storage_specs=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.SetSpec class contains the specification required to set +a new configuration on the namespace. This class is applied in entirety, +replacing the current specification fully.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str or None) – Description for the namespace. +If None, the description of the namespace will be cleared.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quota for the namespace. This will replace the existing +resource constraints on the namespace in entirety. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1. +If None, the resource constraints on the namespace will be cleared.

    • +

  • access_list (list of Instances.Access or None) – Access control associated with the namespace. +If None, the existing access controls on the namespace will be +removed and users will not be able to access this namespace to +create new pods. Existing pods from users will continue to run.

    • +

  • storage_specs (list of Instances.StorageSpec or None) – Storage associated with the namespace. +If None, the existing storage policies will be disassociated with +the namespace and existing limits will be cleared. Pods which are +already using persistent storage from the earlier version of +storage policies will be able to access them till the datastores +are attached to the worker nodes.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – VM Service specification associated with the namespace. This +attribute was added in vSphere API 7.0.2.00100. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) –

    List of Content Libraries used by the VM Image Service. This list +refers to existing Content Libraries in vSphere inventory.

    +

    The Content Libraries specified in {VMServiceSpec#contentLibraries} +will also be included in this list but will be read-only by default +to users.

    +

    If the same Content Library is present both here and in +{VMServiceSpec#contentLibraries}, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings here are honored.

      • +
    +

    . This attribute was added in vSphere API 8.0.2.0. +If None, the existing Content Libraries configured for the VM Image +Service will be removed.

    +

    • +
+
+
+
+ +
+
+class Stats(cpu_used=None, memory_used=None, storage_used=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Stats class contains the basic runtime statistics about +the namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu_used (long) – Overall CPU usage of the namespace, in MHz. This is the sum of CPU +usage across all pods in the Kubernetes namespace.

    • +

  • memory_used (long) – Overall memory usage of the namespace (in mebibytes). This is the +sum of memory usage across all pods.

    • +

  • storage_used (long) – Overall storage used by the namespace (in mebibytes). This is the +sum of storage used by pods across all datastores in the cluster +associated with storage policies configured for the namespace.

    • +
+
+
+
+ +
+
+class StorageSpec(policy=None, limit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.StorageSpec class contains the specification required to +configure storage associated with a namespace. Information in this class +will result in storage quotas on the Kubernetes namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – ID of the storage policy. A Kubernetes storage class is created for +this storage policy if it does not exist already. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • limit (long or None) – The maximum amount of storage (in mebibytes) which can be utilized +by the namespace for this specification. +If None, no limits are placed.

    • +
+
+
+
+ +
+
+class Summary(cluster=None, namespace=None, description=None, config_status=None, stats=None, self_service_namespace=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Summary class contains the basic information about the +namespace on a single vSphere cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the vSphere cluster hosting the namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • namespace (str) – Identifier of the namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • description (str) – Description of the namespace.

    • +

  • config_status (Instances.ConfigStatus) – Current setting for Instances.ConfigStatus.

    • +

  • stats (Instances.Stats) – Basic runtime statistics for the namespace.

    • +

  • self_service_namespace (bool or None) – Flag to indicate the self service namespace. This attribute was +added in vSphere API 7.0.2.00100. +If None, the namespace is not marked as self service namespace.

    • +
+
+
+
+ +
+
+class SummaryV2(supervisor=None, namespace=None, description=None, config_status=None, stats=None, self_service_namespace=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.SummaryV2 class contains the basic information about the +namespace on a Supervisor. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor hosting the namespace. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • namespace (str) – Identifier of the namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • description (str) – Description of the namespace.

    • +

  • config_status (Instances.ConfigStatus) – Current setting for Instances.ConfigStatus.

    • +

  • stats (Instances.Stats) – Basic runtime statistics for the namespace.

    • +

  • self_service_namespace (bool or None) – Flag to indicate the self service namespace. This attribute was +added in vSphere API 7.0.2.00100. +If None, the namespace is not marked as self service namespace.

    • +
+
+
+
+ +
+
+class UpdateSpec(description=None, resource_spec=None, access_list=None, storage_specs=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.UpdateSpec class contains the specification required to +update the configuration on the namespace. This class is applied partially, +and only the specified fields will replace or modify their existing +counterparts.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str or None) – Description for the namespace. +If None, the description of the namespace will not be modified.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quota updates on the namespace. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#updateResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1Update. +If None, the resource constraints on the namespace will not be +modified.

    • +

  • access_list (list of Instances.Access or None) – Access control associated with the namespace. +If None, access controls on the namespace will not be modified. +Existing pods from users will continue to run.

    • +

  • storage_specs (list of Instances.StorageSpec or None) – Storage associated with the namespace. +If None, storage policies and their limit will not be modified. +Pods which are already using persistent storage from the earlier +version of storage policies will be able to access them till the +datastores are attached to the worker nodes.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) –

    VM Service specification associated with the namespace.

    +

    NOTE: Any change in the VM Service Content Libraries associated +with the namespace will be updated and merged with the the Content +Library list in VM Image Service. If {UpdateSpec#contentLibraries} +is unset, the Content Libraries specified here will be honored if +no writable Content Libraries are removed from the current Content +Library list by Instances.get() method, otherwise +InvalidArgument error will be thrown.. This attribute was added in +vSphere API 7.0.2.00100. +If None, the Content Libraries get configured based on the values +in {UpdateSpec#contentLibraries}, if it is specified.

    +

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) –

    List of Content Libraries used by the VM Image Service. This list +refers to existing Content Libraries in vSphere inventory.

    +

    The Content Libraries specified in {VMServiceSpec#contentLibraries} +will also be included in this list but will be read-only by default +to users.

    +

    If the same Content Library is present both here and in +{VMServiceSpec#contentLibraries}, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings here are honored.

      • +
    +

    NOTE: Any change in the VM Image Service Content Libraries +associated with the namespace will be updated and merged with the +Content Library list in Instances.VMServiceSpec. If +{UpdateSpec#vmServiceSpec#contentLibraries} is unset, the Content +Libraries specified here will be honored and the Content Libraries +removed from the current Content Library list by +Instances.get() method will also be removed from VM Service.. +This attribute was added in vSphere API 8.0.2.0. +If None, the Content Libraries get configured based on the values +in {UpdateSpec#vmServiceSpec#contentLibraries}, if it is specified.

    +

    • +
+
+
+
+ +
+
+class VMServiceSpec(content_libraries=None, vm_classes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.VMServiceSpec class contains the specification required +to configure the VM Service specification associated with a namespace.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • content_libraries (set of str or None) –

    Set of Content Libraries for use by the VM Service. The Content +Libraries specified should exist in vSphere inventory.

    +

    The Content Libraries specified for the VM Image Service, using +{CreateSpec#contentLibraries} during Instances.create() +method or {UpdateSpec#contentLibraries} during +Instances.update() method or {SetSpec#contentLibraries} +during Instances.set() method will also be included in this +list.

    +

    If the same Content Library is present both here and in VM Image +Service specification, then:

    +
      +

    • The Content Library is only surfaced to users once.

      • +

    • The settings in VM Image Service specification are honored.

      • +
    +

    . This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: com.vmware.content.Library. +This attribute is optional because it was added in a newer version +than its parent node.

    +

    • +

  • vm_classes (set of str or None) –

    Set of VirtualMachineClasses for use by the VM Service. The class +names specified here should exist in vSphere inventory. If this +field is empty in an updated specification, all +VirtualMachineClasses that are currently associated with the +namespace will be disassociated from it.

    +

    NOTE: Any change in virtual machine classes associated with the +namespace will not impact existing VMs.. This attribute was added +in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass. +When methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.VirtualMachineClass. +This attribute is optional because it was added in a newer version +than its parent node.

    +

    • +
+
+
+
+ +
+
+create(spec)
+

Create a namespace object on a single vSphere cluster.

+
+
Parameters
+

spec (Instances.CreateSpec) – The specification for setting up the namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a namespace with the same name exists in vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors or if an invalid name is specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated Supervisor cluster is being disabled or if the +associated Supervisor cluster is being restored from a backup. When +a Supervisor cluster is restored, there’s a window of time during +which the restored Supervisor cluster’s state is being synchronized +back to vCenter. During that time, namespace creation is not +allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Instances.CreateSpec.cluster is not registered on this +vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if:attr:Instances.CreateSpec.cluster is not enabled for +Namespaces, or if the networks field is set when the +Instances.CreateSpec.cluster hosting the namespace uses +NSXT_CONTAINER_PLUGIN or NSXT_VPC as its network provider, or if +the Supervisor cluster does not support customizable VM classes.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
+
+ +
+
+create_v2(spec)
+

Create a namespace object on a Supervisor. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

spec (Instances.CreateSpecV2) – The specification for setting up the namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a namespace with the same name exists in vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors or if an invalid name is specified.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated Supervisor is being disabled or if the associated +Supervisor is being restored from a backup. When a Supervisor is +restored, there’s a window of time during which the restored +Supervisor’s state is being synchronized back to vCenter. During +that time, namespace creation is not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor is not registered on this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the Supervisor is not enabled for Namespaces, or if the networks +field is set when the Supervisor hosting the namespace uses +NSXT_CONTAINER_PLUGIN or NSXT_VPC as its network provider, or if +the Supervisor does not support customizable VM classes.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
+
+ +
+
+delete(namespace)
+

Delete the namespace object in the cluster.

+
+
Parameters
+

namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the associated Supervisor cluster is being restored from a +backup. When a Supervisor cluster is restored, there’s a window of +time during which the restored Supervisor cluster’s state is being +synchronized back to vCenter. During that time, namespace deletion +is not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified namespace could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
+
+ +
+
+get(namespace)
+

Returns information about a specific namespace on a single vSphere +cluster.

+
+
Parameters
+

namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

+
+
Return type
+

Instances.Info

+
+
Returns
+

Information about the desired state of the specified namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+get_v2(namespace)
+

Returns information about a specific namespace on a Supervisor. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

+
+
Return type
+

Instances.InfoV2

+
+
Returns
+

Information about the desired state of the specified namespace on a +Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list()
+

Returns the information about all namespaces in this vCenter Server. +The information is tied to a single vSphere cluster.

+
+
Return type
+

list of Instances.Summary

+
+
Returns
+

Information about all namespaces in this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list_v2()
+

Returns the information about all namespaces in this vCenter Server. +The information is tied to a Supervisor. This method was added in +vSphere API 8.0.0.1.

+
+
Return type
+

list of Instances.SummaryV2

+
+
Returns
+

Information about all namespaces in this vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+set(namespace, spec)
+

Set a new configuration on the namespace object. The specified +configuration is applied in entirety and will replace the current +configuration fully.

+
+
Parameters
+
    +

  • namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • spec (Instances.SetSpec) – New specification for the namespace.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the namespace is marked for deletion or if the associated +Supervisor cluster is being disabled or if the associated +Supervisor cluster is being restored from a backup. When a +Supervisor cluster is restored, there’s a window of time during +which the restored Supervisor cluster’s state is being synchronized +back to vCenter. During that time, namespace configuration +modifications are not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace with the name namespace could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if customizable VM classes are not suported for this Supervisor +cluster.

+
+
+
+ +
+
+update(namespace, spec)
+

Update the namespace object. The specified configuration is applied +partially and None fields in spec will leave those parts of +configuration as-is.

+
+
Parameters
+
    +

  • namespace (str) – Identifier for the namespace. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • spec (Instances.UpdateSpec) – Specification for updating the namespace.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the namespace is marked for deletion or if the associated +Supervisor cluster is being disabled or if the associated +Supervisor cluster is being restored from a backup. When a +Supervisor cluster is restored, there’s a window of time during +which the restored Supervisor cluster’s state is being synchronized +back to vCenter. During that time, namespace configuration +modifications are not allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if namespace with the name namespace could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Configure privilege or the +namespace identifier begins with “vmware-system” prefix.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if customizable VM classes are not suported for this Supervisor +cluster.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespaces_client.NamespaceSelfService(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The NamespaceSelfService class provides methods to activate and +deactivate a namespace template that empowers users as self-service +namespace users. If the service is activated on a cluster, users can create +Supervisor Namespaces through kubectl create namespace command without the +need of extra assistance. This class was added in vSphere API 7.0.2.00100.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ActivateTemplateSpec(template=None, permissions=None, resource_spec=None, storage_specs=None, networks=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceSelfService.ActivateTemplateSpec class contains the +specification required to create or update namespace template. The create +or update template operations are combined with service activation in a +single operation. This class was added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • template (str) – Identifier of the namespace template that is being activated. This +attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +

  • permissions (list of NamespaceTemplates.Subject) – Namespace Self Service permission to subjects. This attribute was +added in vSphere API 7.0.2.00100.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct) – Resource quotas that the template defines. Resource quota on the +namespace. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1. This +attribute was added in vSphere API 7.0.2.00100.

    • +

  • storage_specs (list of Instances.StorageSpec) – Storage associated with the self service namespace. This attribute +was added in vSphere API 7.0.2.00100.

    • +

  • networks (list of str or None) – vSphere Namespaces network objects to be associated with the +namespace. The values of this list need to reference names of +pre-existing +com.vmware.vcenter.namespace_management.Networks.Info classs. +This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +The field must be left None if the cluster hosting the namespace +uses NSXT_CONTAINER_PLUGIN as the network provider, since the +network(s) for this namespace will be managed by NSX-T Container +Plugin. If field is None when the cluster hosting the namespace +uses VSPHERE_NETWORK as its network provider, the namespace will +automatically be associated with the cluster’s Supervisor Primary +Workload Network. The field currently accepts at most only 1 +vSphere Namespaces network object reference.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – VM Service specification to be associated with the namespace +template. Namespaces created using this template will have access +to the virtual machine classes and Content Libraries specified in +this {ActivateTemplateSpec#vmServiceSpec} by default. This +attribute was added in vSphere API 7.0.3.2. +If None, the namespaces created using this template will not have +access to any virtual machine classes, and to any Content Libraries +by default unless Content Libraries are specified in the +{ActivateTemplateSpec#contentLibraries}.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) – Content Library specifications to be associated with the namespace +template. Namespaces created using this template will have access +to the Content Libraries specified in this +{ActivateTemplateSpec#contentLibraries} by default. This attribute +was added in vSphere API 8.0.2.0. +If None, the namespaces created using this template will not have +access to any Content Libraries by default unless Content Libraries +are specified in the {ActivateTemplateSpec#vmServiceSpec}.

    • +
+
+
+
+ +
+
+class Capability(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The NamespaceSelfService.Capability class describes the self-service +namespace capability of the cluster on which vSphere Namespaces enabled. +This enumeration was added in vSphere API 7.0.2.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Capability instance.

+
+
+
+
+NOTSUPPORTED = Capability(string='NOTSUPPORTED')
+

The value that indicates the cluster doesn’t support the self-service +namespace capability. The expected transition UNKNOWN –> NOTSUPPORTED. +This class attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+SUPPORTED = Capability(string='SUPPORTED')
+

The value that indicates the cluster supports self-service namespace +capability. The expected transition UNKNOWN –> SUPPORTED. This class +attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+UNKNOWN = Capability(string='UNKNOWN')
+

The initial value that represents the in-progress activity of determining +the cluster’s self-service namespace capability. This class attribute was +added in vSphere API 7.0.2.00100.

+
+ +
+ +
+
+class Info(cluster=None, capability=None, status=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceSelfService.Info class contains detailed information about +the namespace self service. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster to which namespace service is +associated. This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • capability (NamespaceSelfService.Capability) – The self-service namespace capability of the cluster with vSphere +Namespaces enabled. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • status (NamespaceSelfService.Status) – The current status of the namespace-self-service. This attribute +was added in vSphere API 7.0.2.00100.

    • +

  • messages (list of Instances.Message) – Current set of messages associated with the object. This attribute +was added in vSphere API 7.0.2.00100.

    • +
+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The page describes the status of the namespace self-service on the cluster +on which vSphere Namespaces enabled. This enumeration was added in vSphere +API 7.0.2.00100.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+CONFIGURING = Status(string='CONFIGURING')
+

The configuration is being applied to the service. This class attribute was +added in vSphere API 7.0.2.00100.

+
+ +
+
+DEACTIVATED = Status(string='DEACTIVATED')
+

The namespace self service is deactivated. This status also represents the +initial status of the service before activation. The expected transitions +after the service is activated: 1. CONFIGURING –> RUNNING –> REMOVING –> +DEACTIVATED 2. CONFIGURING –> REMOVING –> DEACTIVATED. This class +attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+ERROR = Status(string='ERROR')
+

Failed to apply the configuration to the namespace self-service or unable +to deactivate the namespace self-service, user intervention needed. The +expected transitions: 1. CONFIGURING –> ERROR 2. CONFIGURING –> RUNNING +–> ERROR 3. CONFIGURING –> RUNNING –> REMOVING –> ERROR 4. CONFIGURING +–> REMOVING –> ERROR The NamespaceSelfService.Info.messages field +captures the relevant error messages explaining this ERROR status. This +class attribute was added in vSphere API 7.0.2.00100.

+
+ +
+
+REMOVING = Status(string='REMOVING')
+

The configuration is being removed and service is being deleted. The +expected transitions: 1. CONFIGURING –> RUNNING –> REMOVING 2. +CONFIGURING –> REMOVING. This class attribute was added in vSphere API +7.0.2.00100.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The namespace self service is configured correctly. The expected +transitions: 1. CONFIGURING –> RUNNING 2. RUNNING –> CONFIGURING. This +transition occurs in the below scenarios: a. When different Dev +Users/Groups are empowered with self-service namespace access. b. To +reconcile the state of the cluster after the cluster upgrade. This class +attribute was added in vSphere API 7.0.2.00100.

+
+ +
+ +
+
+class Summary(cluster=None, capability=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceSelfService.Summary class contains basic information about +the namespace service. This class was added in vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster to which namespace service is +associated. This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • capability (NamespaceSelfService.Capability) – The self-service namespace capability of the cluster with vSphere +Namespaces enabled. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • status (NamespaceSelfService.Status) – The current status of the namespace-self-service. This attribute +was added in vSphere API 7.0.2.00100.

    • +
+
+
+
+ +
+
+activate(cluster)
+

Activate Namespace Self Service on the cluster on which vSphere +Namespaces enabled. This operation empowers Dev Users/Groups as +self-service namespace users to create Supervisor Namespaces through +kubectl create namespace command. activate requires the availability of +one or more templates in the system. A Supervisor can be running on one +or multiple vSphere Zones, and each vSphere Zone is associated with one +or more vSphere Clusters. If a Supervisor running on the specified +vSphere Cluster is running on additional vSphere Clusters, this +operation will apply to Supervisor components running on the other +vSphere Clusters in addition to the specified vSphere Cluster. To call +this API on a Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+

cluster (str) – Identifier for the cluster on which vSphere Namespaces will be +enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the cluster already has Namespace Self Service activated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster with vSphere Namespaces enabled could not be located or +no namespace templates exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the specified cluster is not licensed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the service is marked for deactivation or the associated cluster +is being disabled or no namespace template exists in the system.

+
+
+
+ +
+
+activate_with_template(cluster, spec)
+

Activate Namespace Self Service on the cluster after configuring +namespace template. This is another variant of activate except +configures template before activation. The template configuration +includes either creating a new template or updating the existing +template, depending on the template’s existence. Here is supported the +flow of actions using the activateWithTemplate call: 1. Activate with +the new template using activateWithTemplate call. 2. Deactivate using +deactivate call. 3. Active with updating the existing template using +activateWithTemplate. A Supervisor can be running on one or multiple +vSphere Zones, and each vSphere Zone is associated with one or more +vSphere Clusters. If a Supervisor running on the specified vSphere +Cluster is running on additional vSphere Clusters, this operation will +apply to Supervisor components running on the other vSphere Clusters in +addition to the specified vSphere Cluster. To call this API on a +Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which vSphere Namespaces will be +enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (NamespaceSelfService.ActivateTemplateSpec) – Specification for activating namespace self service on the cluster +by granting users/groups to create Supervisor Namespaces.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the cluster already has Namespace Self Service activated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster with vSphere Namespaces enabled could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the specified cluster is not licensed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the service is marked for deactivation or the associated cluster +is being disabled.

+
+
+
+ +
+
+deactivate(cluster)
+

Deactivate Namespace Self Service on the cluster on which vSphere +Namespaces enabled. This operation reverses Dev Users/Group’s +self-service namespace capability on the cluster. A Supervisor can be +running on one or multiple vSphere Zones, and each vSphere Zone is +associated with one or more vSphere Clusters. If a Supervisor running +on the specified vSphere Cluster is running on additional vSphere +Clusters, this operation will apply to Supervisor components running on +the other vSphere Clusters in addition to the specified vSphere +Cluster. To call this API on a Supervisor with multiple vSphere +Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+

cluster (str) – Identifier for the cluster for which vSphere Namespaces will be +disabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster with vSphere Namespaced enabled is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the service is not activated.

+
+
+
+ +
+
+get(cluster)
+

Returns information about Namespace Self Service of a specific cluster. +A Supervisor can be running on one or multiple vSphere Zones, and each +vSphere Zone is associated with one or more vSphere Clusters. If a +Supervisor running on the specified vSphere Cluster is running on +additional vSphere Clusters, this operation will apply to Supervisor +components running on the other vSphere Clusters in addition to the +specified vSphere Cluster. To call this API on a Supervisor with +multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+

cluster (str) – Identifier for the cluster on which vSphere Namespaces are enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

NamespaceSelfService.Info

+
+
Returns
+

Information about the namespace self service associated with the +specified cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster with vSphere Namespaced enabled could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list()
+

Returns basic information about Namespace Self Service on all clusters +on which vSphere Namespaces are enabled on this vCenter. This method +was added in vSphere API 7.0.2.00100.

+
+
Return type
+

list of NamespaceSelfService.Summary

+
+
Returns
+

List of summary of Namespace Self Service associated with all +clusters with vSphere Namespaces enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespaces_client.NamespaceTemplates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The NamespaceTemplates class provides methods to create and update +namespace templates on a cluster. The namespace templates are used if the +NamespaceSelfService is enabled on a Supervisor. This class was added +in vSphere API 7.0.2.00100.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(template=None, resource_spec=None, storage_specs=None, networks=None, permissions=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.CreateSpec class contains the specification +required to create namespace template. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • template (str) – Identifier of the namespace template. This has DNS_LABEL +restrictions as specified in ` +<https://tools.ietf.org/html/rfc1123>`_. This name is unique across +all namespaces templates in this vCenter server. This attribute was +added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct) – Resource quotas that this template defines. Resource quota on the +namespace. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1. This +attribute was added in vSphere API 7.0.2.00100.

    • +

  • storage_specs (list of Instances.StorageSpec) – Storage that this template defines and will be associated with a +namespace after namespace realization. This field should not be +empty and at least one policy should be supplied. The {link create} +throws {term InvalidArgument} exception if this field is set empty. +This attribute was added in vSphere API 7.0.2.00100.

    • +

  • networks (list of str or None) – vSphere Networks that this template captures and are associated +with the namespace after namespace realization. vSphere Namespaces +network objects to be associated with the namespace. The values of +this list need to reference names of pre-existing +com.vmware.vcenter.namespace_management.Networks.Info classs. +This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +The field must be left None if the cluster hosting the namespace +uses NSXT_CONTAINER_PLUGIN or NSXT_VPC as the network provider, +since the network(s) for this namespace will be managed by NSX-T +Container Plugin. If field is None when the cluster hosting the +namespace uses VSPHERE_NETWORK as its network provider, the +namespace will automatically be associated with the cluster’s +Supervisor Primary Workload Network. The field currently accepts at +most only 1 vSphere Namespaces network object reference.

    • +

  • permissions (list of NamespaceTemplates.Subject or None) – Permissions associated with namespace template. This attribute was +added in vSphere API 7.0.2.00100. +If None, only users with the Administrator role can use this +template; for example, this template is applied to the namespace +created by self-service-users with the Administrator role.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – VM Service specification to be associated with the namespace +template. Namespaces created using this template will have access +to the virtual machine classes and Content Libraries specified in +this {CreateSpec#vmServiceSpec} by default. This attribute was +added in vSphere API 7.0.3.2. +If None, the namespaces created using this template will not have +access to any virtual machine classes by default, and to any +Content Libraries by default unless Content Libraries are specified +in the {CreateSpec#contentLibraries}.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) – Content Library specifications to be associated with the namespace +template. Namespaces created using this template will have access +to the Content Libraries specified in this +{CreateSpec#contentLibraries} by default. This attribute was added +in vSphere API 8.0.2.0. +If None, the namespaces created using this template will not have +access to any Content Libraries by default unless Content Libraries +are specified in the {CreateSpec#vmServiceSpec}.

    • +
+
+
+
+ +
+
+class Info(cluster=None, template=None, resource_spec=None, storage_specs=None, networks=None, permissions=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.Info class contains the detailed information +about the namespace template. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the vSphere cluster associated with namespace +template. This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • template (str) – Name of the namespace template. This attribute was added in vSphere +API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quotas that this template defines. Quotas on the namespace +resources. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for the type of the value for this field. This attribute was added +in vSphere API 7.0.2.00100. +If None, no resource constraints are defined in the namespace +template.

    • +

  • storage_specs (list of Instances.StorageSpec) – Storage that this template defines and will be associated with a +namespace after namespace realization. This attribute was added in +vSphere API 7.0.2.00100.

    • +

  • networks (list of str or None) – vSphere Networks that this template captures and are associated +with the namespace after namespace realization. This attribute was +added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +This field is None if the cluster hosting this namespace uses +NSXT_CONTAINER_PLUGIN or NSXT_VPC as its network provider.

    • +

  • permissions (list of NamespaceTemplates.Subject or None) – Permissions associated with namespace template. This attribute was +added in vSphere API 7.0.2.00100. +If None, only users with the Administrator role can use this +template; for example, this template is applied to the namespace +created by self-service-users with the Administrator role.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – Current set of virtual machine classes and Content Libraries +associated with the template. This attribute was added in vSphere +API 7.0.3.2. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) – Current set of Content Library specifications associated with the +template. This attribute was added in vSphere API 8.0.2.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class InfoV2(supervisor=None, template=None, resource_spec=None, storage_specs=None, networks=None, permissions=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.InfoV2 class contains the detailed information +about the namespace template on a Supervisor. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor associated with namespace template. +This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • template (str) – Name of the namespace template. This attribute was added in vSphere +API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quotas that this template defines. Quotas on the namespace +resources. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for the type of the value for this field. This attribute was added +in vSphere API 7.0.2.00100. +If None, no resource constraints are defined in the namespace +template.

    • +

  • storage_specs (list of Instances.StorageSpec) – Storage that this template defines and will be associated with a +namespace after namespace realization. This attribute was added in +vSphere API 7.0.2.00100.

    • +

  • networks (list of str or None) – vSphere Networks that this template captures and are associated +with the namespace after namespace realization. This attribute was +added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +This field is None if the cluster hosting this namespace uses +NSXT_CONTAINER_PLUGIN or NSXT_VPC as its network provider.

    • +

  • permissions (list of NamespaceTemplates.Subject or None) – Permissions associated with namespace template. This attribute was +added in vSphere API 7.0.2.00100. +If None, only users with the Administrator role can use this +template; for example, this template is applied to the namespace +created by self-service-users with the Administrator role.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – Current set of virtual machine classes and Content Libraries +associated with the template. This attribute was added in vSphere +API 7.0.3.2. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) – Current set of Content Library specifications associated with the +template. This attribute was added in vSphere API 8.0.2.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.namespaces.NamespaceTemplate'
+

The resource type for namespace template. This class attribute was added in +vSphere API 7.0.2.00100.

+
+ +
+
+class Subject(subject_type=None, subject=None, domain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.Subject class contains the user or group +information granted for namespace self service. This class was added in +vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • subject_type (Access.SubjectType) – Type of the subject. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • subject (str) – Name of the subject. This attribute was added in vSphere API +7.0.2.00100.

    • +

  • domain (str) – Domain of the subject. This attribute was added in vSphere API +7.0.2.00100.

    • +
+
+
+
+ +
+
+class Summary(cluster=None, template=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.Summary class contains the basic information +about the namespace template. This class was added in vSphere API +7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the vSphere cluster associated with namespace +template. This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • template (str) – Name of the namespace template. This attribute was added in vSphere +API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +
+
+
+
+ +
+
+class SummaryV2(supervisor=None, template=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.SummaryV2 class contains the basic information +about the namespace template on a Supervisor. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor associated with namespace template. +This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • template (str) – Name of the namespace template. This attribute was added in vSphere +API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +
+
+
+
+ +
+
+class UpdateSpec(resource_spec=None, storage_specs=None, networks=None, permissions=None, vm_service_spec=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NamespaceTemplates.UpdateSpec class contains the specification +required to update a namespace namespace template. This class was added in +vSphere API 7.0.2.00100.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • resource_spec (vmware.vapi.struct.VapiStruct or None) – Resource quota on the namespace. Refer to +com.vmware.vcenter.namespace_management.NamespaceResourceOptions.Info#createResourceQuotaType +and use +com.vmware.vcenter.namespace_management.NamespaceResourceOptions#get +for retrieving the type for the value for this field. For an +example of this, see ResourceQuotaOptionsV1. This +attribute was added in vSphere API 7.0.2.00100. +If None, no resource limits will be set on the namespace.

    • +

  • storage_specs (list of Instances.StorageSpec or None) – Storage that this template defines and will be associated with a +namespace after namespace realization. This attribute was added in +vSphere API 7.0.2.00100. +If None then no update will be made.

    • +

  • networks (list of str or None) – vSphere Namespaces network objects to be associated with the +namespace. The values of this list need to reference names of +pre-existing +com.vmware.vcenter.namespace_management.Networks.Info classs. +This attribute was added in vSphere API 7.0.2.00100. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.namespace_management.Network. +The field must be left None if the cluster hosting the namespace +uses NSXT_CONTAINER_PLUGIN or NSXT_VPC as the network provider, +since the network(s) for this namespace will be managed by NSX-T +Container Plugin. If field is None when the cluster hosting the +namespace uses VSPHERE_NETWORK as its network provider, the +namespace will automatically be associated with the cluster’s +Supervisor Primary Workload Network. The field currently accepts at +most only 1 vSphere Namespaces network object reference.

    • +

  • permissions (list of NamespaceTemplates.Subject or None) – Permissions associated with namespace template. This attribute was +added in vSphere API 7.0.2.00100. +If None, only users with the Administrator role can use this +template; for example, this template is applied to the namespace +created by self-service-users with the Administrator role.

    • +

  • vm_service_spec (Instances.VMServiceSpec or None) – VM Service specification to be associated with the namespace +template. The virtual machine classes and Content Library +associations of the template will be updated according to this +{UpdateSpec#vmServiceSpec}. This attribute was added in vSphere API +7.0.3.2. +If None, the namespaces created using this template will not have +access to any virtual machine classes by default, and to any +Content Libraries by default unless Content Libraries are specified +in the {UpdateSpec#contentLibraries}.

    • +

  • content_libraries (list of Instances.ContentLibrarySpec or None) – Content Library specifications to be associated with the namespace +template. Namespaces created using this template will have access +to the Content Libraries specified in this +{UpdateSpec#contentLibraries} by default. This attribute was added +in vSphere API 8.0.2.0. +If None, the namespaces created using this template will not have +access to any Content Libraries by default unless Content Libraries +are specified in the {UpdateSpec#vmServiceSpec}.

    • +
+
+
+
+ +
+
+create(cluster, spec)
+

Creates a namespace template on a cluster on which vSphere Namespaces +are enabled in this vCenter Server. This release supports creating a +single namespace template, and the call fails if there is a request to +make another one. A Supervisor can be running on one or multiple +vSphere Zones, and each vSphere Zone is associated with one or more +vSphere Clusters. If a Supervisor running on the specified vSphere +Cluster is running on additional vSphere Clusters, this operation will +apply to Supervisor components running on the other vSphere Clusters in +addition to the specified vSphere Cluster. To call this API on a +Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which vSphere Namespaces are enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (NamespaceTemplates.CreateSpec) – Specification for setting up the namespace template.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors, or if {link +CreateSpec#storageSpecs} is empty, or if {link +CreateSpec#resourceSpec} is not set with {term memory_limit}, {term +cpu_limit}, {term storage_request_limit}, or if {link +CreateSpec#networks} is not set with networks if the {term cluster} +hosting the namespaces uses VSPHERE_NETWORK as its network +provider, or if {link CreateSpec#networks} is not empty if the +{term cluster} hosting the namespaces uses NSXT_CONTAINER_PLUGIN or +NSXT_VPC as its network provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if a request arrives to create a second template or to grant access +to a user or group from an external identity provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the namespace template with given name already exists.

+
+
+
+ +
+
+create_v2(supervisor, spec)
+

Creates a namespace template on a Supervisor. This release supports +creating a single namespace template, and the call fails if there is a +request to make another one. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • spec (NamespaceTemplates.CreateSpec) – Specification for setting up the namespace template.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors, or if {link +CreateSpec#storageSpecs} is empty, or if {link +CreateSpec#resourceSpec} is not set with {term memory_limit}, {term +cpu_limit}, {term storage_request_limit}, or if {link +CreateSpec#networks} is not set with networks if the Supervisor +hosting the namespaces uses VSPHERE_NETWORK as its network +provider, or if {link CreateSpec#networks} is not empty if the +Supervisor hosting the namespaces uses NSXT_CONTAINER_PLUGIN or +NSXT_VPC as its network provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if a request arrives to create a second template or to grant access +to a user or group from an external identity provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the namespace template with given name already exists.

+
+
+
+ +
+
+get(cluster, template)
+

Get the information about a namespace template on given cluster. A +Supervisor can be running on one or multiple vSphere Zones, and each +vSphere Zone is associated with one or more vSphere Clusters. If a +Supervisor running on the specified vSphere Cluster is running on +additional vSphere Clusters, this operation will apply to Supervisor +components running on the other vSphere Clusters in addition to the +specified vSphere Cluster. To call this API on a Supervisor with +multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which vSphere Namespaces are enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • template (str) – Name of the namespace template. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +
+
+
Return type
+

NamespaceTemplates.Info

+
+
Returns
+

Information about the namespace template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t exist or if template doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+get_v2(supervisor, template)
+

Get the information about a namespace template on a Supervisor. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • template (str) – Name of the namespace template. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +
+
+
Return type
+

NamespaceTemplates.InfoV2

+
+
Returns
+

Information about the namespace template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor doesn’t exist or if template doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list(cluster)
+

Returns information about all the namespace templates associated with a +cluster on which vSphere Namespaces are enabled in this vCenter Server. +A Supervisor can be running on one or multiple vSphere Zones, and each +vSphere Zone is associated with one or more vSphere Clusters. If a +Supervisor running on the specified vSphere Cluster is running on +additional vSphere Clusters, this operation will apply to Supervisor +components running on the other vSphere Clusters in addition to the +specified vSphere Cluster. To call this API on a Supervisor with +multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+

cluster (str) – Identifier for the cluster on which vSphere Namespaces are enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

list of NamespaceTemplates.Summary

+
+
Returns
+

List of summary of all namespace templates associated with +cluster with vSphere Namespaces enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+list_v2(supervisor)
+

Returns information about all the namespace templates associated with a +Supervisor. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

supervisor (str) – Identifier for the Supervisor. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Return type
+

list of NamespaceTemplates.SummaryV2

+
+
Returns
+

List of summary of all namespace templates associated with the +Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+update(cluster, template, spec)
+

Updates a namespace template associated with cluster on which vSphere +Namespaces are enabled in this vCenter Server. The specified +configuration is applied partially and None fields in spec will +leave those parts of configuration as-is. A Supervisor can be running +on one or multiple vSphere Zones, and each vSphere Zone is associated +with one or more vSphere Clusters. If a Supervisor running on the +specified vSphere Cluster is running on additional vSphere Clusters, +this operation will apply to Supervisor components running on the other +vSphere Clusters in addition to the specified vSphere Cluster. To call +this API on a Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.2.00100.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for cluster on which vSphere Namespaces are enabled. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • template (str) – Name of the namespace template. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +

  • spec (NamespaceTemplates.UpdateSpec) – Specification for updating the namespace template.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t exist or if template doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if trying to grant access to a user or group from an external +identity provider.

+
+
+
+ +
+
+update_v2(supervisor, template, spec)
+

Updates a namespace template associated with a Supervisor. The +specified configuration is applied partially and None fields in +spec will leave those parts of configuration as-is. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – Identifier for the Supervisor. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • template (str) – Name of the namespace template. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespaces.NamespaceTemplate.

    • +

  • spec (NamespaceTemplates.UpdateSpec) – Specification for updating the namespace template.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor doesn’t exist or if template doesn’t exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contain any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.SelfServiceManage privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if trying to grant access to a user or group from an external +identity provider.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1(memory_limit=None, memory_limit_default=None, memory_request_default=None, cpu_limit=None, cpu_limit_default=None, cpu_request_default=None, storage_request_limit=None, pod_count=None, service_count=None, deployment_count=None, daemon_set_count=None, replica_set_count=None, replication_controller_count=None, stateful_set_count=None, config_map_count=None, secret_count=None, persistent_volume_claim_count=None, job_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceQuotaOptionsV1 class represents the resource quota limits +which can be applied on the namespace. Refer to ` +<https://kubernetes.io/docs/concepts/policy/resource-quotas>`_ for +information related to the properties of this object and what they map to.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • memory_limit (long or None) – This is equivalent to ‘limits.memory’ option which is the maximum +memory limit (in mebibytes) across all pods which exist in a +non-terminal state in the namespace. This value translates to the +memory limit on the ResourcePool in vCenter Server created for the +namespace. +If None, no memory limits are set on the ResourcePool for the +namespace.

    • +

  • memory_limit_default (long or None) – This represents the default memory limit (in mebibytes) for +containers in the pod. This translates to default memory limit in a +LimitRange object. Refer ` for information about LimitRange. +<https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/>`_ +If None, no default memory limits are set on containers in the pod.

    • +

  • memory_request_default (long or None) – This represents the default memory request (in mebibytes) for +containers in the pod. This translates to default memory request in +a LimitRange object. Refer ` for information about LimitRange. +<https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/>`_ +If None, no default memory requests are set on containers in the +pod.

    • +

  • cpu_limit (long or None) – This is equivalent to ‘limits.cpu’ option which is the maximum CPU +limit (in MHz) across all pods which exist in a non-terminal state +in the namespace. If specified, this limit should be at least 10 +MHz. This value translates to the CPU limit on the ResourcePool in +vCenter Server created for the namespace. +If None, no CPU limits are set on the ResourcePool for the +namespace.

    • +

  • cpu_limit_default (long or None) – This represents the default cpu limit (in MHz) for containers in +the pod. +If None, no default CPU limits are set on containers in the pod. +Refer ` for information about LimitRange. If specified, this limit +should be at least 10 MHz. +<https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/>`_

    • +

  • cpu_request_default (long or None) – This represents the default CPU request (in MHz) for containers in +the pod. +If None, no default CPU requests are set on containers in the pod. +Refer ` for information about LimitRange. If specified, this field +should be at least 10 MHz. +<https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-default-namespace/>`_

    • +

  • storage_request_limit (long or None) – This represents ‘requests.storage’ option which is the maximum +storage request (in mebibytes) across all persistent volume claims +from pods which exist in a non-terminal state in the namespace. +If None, no storage request limits are set on the namespace.

    • +

  • pod_count (long or None) – This represents ‘pods’ option which is the maximum number of pods +which exist in a non-terminal state in the namespace. +If None, no pod limits are set on the namespace.

    • +

  • service_count (long or None) – This represents ‘count/services’ option which is the maximum number +of services in the namespace. +If None, no service limits are set on the namespace.

    • +

  • deployment_count (long or None) – This represents ‘count/deployments.apps’ option which is the +maximum number of deployments in the namespace. +If None, no deployment limits are set on the namespace.

    • +

  • daemon_set_count (long or None) – This represents ‘count/daemonsets.apps’ option which is the maximum +number of DaemonSets in the namespace. +If None, no daemonset limits are set on the namespace.

    • +

  • replica_set_count (long or None) – This represents ‘count/replicasets.apps’ option which is the +maximum number of ReplicaSets in the namespace. +If None, no replicaset limits are set on the namespace.

    • +

  • replication_controller_count (long or None) – This represents ‘count/replicationcontrollers’ option which is the +maximum number of ReplicationControllers in the namespace. +If None, no replicationcontroller limits are set on the namespace.

    • +

  • stateful_set_count (long or None) – This represents ‘count/statefulsets.apps’ option which is the +maximum number of StatefulSets in the namespace. +If None, no statefulset limits are set on the namespace.

    • +

  • config_map_count (long or None) – This represents ‘count/configmaps’ option which is the maximum +number of ConfigMaps in the namespace. +If None, no configmap limits are set on the namespace.

    • +

  • secret_count (long or None) – This represents ‘count/secrets’ option which is the maximum number +of secrets in the namespace. +If None, no secret limits are set on the namespace.

    • +

  • persistent_volume_claim_count (long or None) – This represents ‘count/persistentvolumeclaims’ option which is the +maximum number of PersistentVolumeClaims in the namespace. +If None, no persistentvolumeclaim limits are set on the namespace.

    • +

  • job_count (long or None) – This represents ‘count/jobs.batch’ option which is the maximum +number jobs in the namespace. +If None, no job limits are set on the namespace.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1Update(memory_limit=None, memory_limit_unset=None, memory_limit_default=None, memory_limit_default_unset=None, memory_request_default=None, memory_request_default_unset=None, cpu_limit=None, cpu_limit_unset=None, cpu_limit_default=None, cpu_limit_default_unset=None, cpu_request_default=None, cpu_request_default_unset=None, storage_request_limit=None, storage_request_limit_unset=None, pod_count=None, pod_count_unset=None, service_count=None, service_count_unset=None, deployment_count=None, deployment_count_unset=None, daemon_set_count=None, daemon_set_count_unset=None, replica_set_count=None, replica_set_count_unset=None, replication_controller_count=None, replication_controller_count_unset=None, stateful_set_count=None, stateful_set_count_unset=None, config_map_count=None, config_map_count_unset=None, secret_count=None, secret_count_unset=None, persistent_volume_claim_count=None, persistent_volume_claim_count_unset=None, job_count=None, job_count_unset=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceQuotaOptionsV1Update class represents the changes to +resource quota limits which are set on the namespace. Refer to ` <> +Kubernetes Resource Quota +<https://kubernetes.io/docs/concepts/policy/resource-quotas>`_ for +information related to the properties of this object and what they map to.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • memory_limit (long or None) – This represents the new value for ‘limits.memory’ option which is +equivalent to the maximum memory limit (in mebibytes) across all +pods in the namespace. This field is ignored if +ResourceQuotaOptionsV1Update.memory_limit_unset is set to +true. +If None, the existing memory limit on the ResourcePool will be +unchanged if +ResourceQuotaOptionsV1Update.memory_limit_unset is None or +set to false.

    • +

  • memory_limit_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.memory_limit. If this field is +set to true, the existing memory limit on the ResourcePool is +removed. If this field is set to false, the existing memory +limit will be changed to the value specified in +ResourceQuotaOptionsV1Update.memory_limit, if any. +If None, the existing memory limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.memory_limit, if +any.

    • +

  • memory_limit_default (long or None) – This represents the new value for the default memory limit (in +mebibytes) for containers in the pod. This field is ignored if +ResourceQuotaOptionsV1Update.memory_limit_default_unset is +set to true. +If None, the existing memory limit will be unchanged if +ResourceQuotaOptionsV1Update.memory_limit_default_unset is +None or set to false.

    • +

  • memory_limit_default_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.memory_limit_default. If this +field is set to true, the existing default memory limit on +containers in the pod is removed. If this field is set to +false, the existing default memory limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.memory_limit_default, if any. +If None, the existing default memory limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.memory_limit_default, if any.

    • +

  • memory_request_default (long or None) – This represents the new value for the default memory request (in +mebibytes) for containers in the pod. This field is ignored if +ResourceQuotaOptionsV1Update.memory_request_default_unset +is set to true. +If None, the existing memory request will be unchanged if +ResourceQuotaOptionsV1Update.memory_request_default_unset +is None or set to false.

    • +

  • memory_request_default_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.memory_request_default. If +this field is set to true, the existing default memory request +on containers in the pod will be removed. If this field is set to +false, the existing default memory request will be changed to +the value specified in +ResourceQuotaOptionsV1Update.memory_request_default, if +any. +If None, the existing default memory request will be changed to the +value specified in +ResourceQuotaOptionsV1Update.memory_request_default, if +any.

    • +

  • cpu_limit (long or None) – This represents the new value for ‘limits.cpu’ option which is +equivalent to the maximum CPU limit (in MHz) across all pods in the +namespace. This field is ignored if +ResourceQuotaOptionsV1Update.cpu_limit_unset is set to +true. If specified, this limit should be at least 10 MHz. +If None, the existing CPU limit on the ResourcePool will be +unchanged if ResourceQuotaOptionsV1Update.cpu_limit_unset +is None or set to false.

    • +

  • cpu_limit_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.cpu_limit. If this field is +set to true, the existing CPU limit on the ResourcePool is +removed. If this field is set to false, the existing CPU limit +will be changed to the value specified in +ResourceQuotaOptionsV1Update.cpu_limit, if any. +If None, the existing CPU limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.memory_limit, if +any.

    • +

  • cpu_limit_default (long or None) – This represents the new value for the default CPU limit (in Mhz) +for containers in the pod. This field is ignored if +ResourceQuotaOptionsV1Update.cpu_limit_default_unset is set +to true. If specified, this limit should be at least 10 MHz. +If None, the existing default CPU limit will be unchanged if +ResourceQuotaOptionsV1Update.cpu_limit_default_unset is +None or set to false.

    • +

  • cpu_limit_default_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.cpu_limit_default. If this +field is set to true, the existing default CPU limit on +containers in the pod is removed. If this field is set to +false, the existing default CPU limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.cpu_limit_default, if any. +If None, the existing default CPU limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.cpu_limit_default, if any.

    • +

  • cpu_request_default (long or None) – This represents the new value for the default CPU request (in Mhz) +for containers in the pod. This field is ignored if +ResourceQuotaOptionsV1Update.cpu_request_default_unset is +set to true. If specified, this field should be at least 10 +MHz. +If None, the existing default CPU request will be unchanged if +ResourceQuotaOptionsV1Update.cpu_request_default_unset is +None or set to false.

    • +

  • cpu_request_default_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.cpu_request_default. If this +field is set to true, the existing default CPU request on +containers in the pod is removed. If this field is set to +false, the existing default CPU request will be changed to the +value specified in +ResourceQuotaOptionsV1Update.cpu_request_default, if any. +If None, the existing default CPU request will be changed to the +value specified in +ResourceQuotaOptionsV1Update.cpu_request_default, if any.

    • +

  • storage_request_limit (long or None) – This represents the new value for ‘requests.storage’ which is the +limit on storage requests (in mebibytes) across all persistent +volume claims from pods in the namespace. This field is ignored if +if ResourceQuotaOptionsV1Update.storage_request_limit_unset +is set to true. +If None, the existing storage request limit will be unchanged if +ResourceQuotaOptionsV1Update.storage_request_limit_unset is +None or set to false. the namespace.

    • +

  • storage_request_limit_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.storage_request_limit. If this +field is set to true, the existing storage request limit will +be reset. If this field is set to false, the existing storage +request limit will be changed to the value specified in +ResourceQuotaOptionsV1Update.storage_request_limit, if any. +If None, the existing storage request limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.storage_request_limit, if any.

    • +

  • pod_count (long or None) – This represents the new value for ‘podCount’ option which is the +maximum number of pods in the namespace. This field is ignored if +ResourceQuotaOptionsV1Update.pod_count_unset is set to +true. +If None, the existing ‘podCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.pod_count_unset is None or set +to false.

    • +

  • pod_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.pod_count. If this field is +set to true, the existing ‘podCount’ limit on the namespace +will be reset. If this field is set to false, the existing CPU +limit will be changed to the value specified in +ResourceQuotaOptionsV1Update.pod_count, if any. +If None, the existing ‘podCount’ limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.pod_count, if +any.

    • +

  • service_count (long or None) – This represents the new value for ‘serviceCount’ option which is +the maximum number of services in the namespace. This field is +ignored if ResourceQuotaOptionsV1Update.service_count_unset +is set to true. +If None, the existing ‘serviceCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.service_count_unset is None or +set to false.

    • +

  • service_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.service_count. If this field +is set to true, the existing ‘serviceCount’ limit on the +namespace will be reset. If this field is set to false, the +existing service count limit will be changed to the value specified +in ResourceQuotaOptionsV1Update.service_count, if any. +If None, the existing ‘serviceCount’ limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.service_count, if any.

    • +

  • deployment_count (long or None) – This represents the new value for ‘deploymentCount’ option which is +the maximum number of deployments in the namespace. This field is +ignored if +ResourceQuotaOptionsV1Update.deployment_count_unset is set +to true. +If None, the existing ‘deploymentCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.deployment_count_unset is None +or set to false.

    • +

  • deployment_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.deployment_count. If this +field is set to true, the existing ‘deploymentCount’ limit on +the namespace will be reset. If this field is set to false, the +existing deployment count limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.deployment_count, +if any. +If None, the existing ‘deploymentCount’ limit will be changed to +the value specified in +ResourceQuotaOptionsV1Update.deployment_count, if any.

    • +

  • daemon_set_count (long or None) – This represents the new value for ‘daemonSetCount’ option which is +the maximum number of DaemonSets in the namespace. This field is +ignored if +ResourceQuotaOptionsV1Update.daemon_set_count_unset is set +to true. +If None, the existing ‘daemonSetCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.daemon_set_count_unset is None +or set to false.

    • +

  • daemon_set_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.daemon_set_count. If this +field is set to true, the existing ‘daemonSetCount’ limit on +the namespace will be reset. If this field is set to false, the +existing daemonset count limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.daemon_set_count, +if any. +If None, the existing ‘daemonSetCount’ limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.daemon_set_count, if any.

    • +

  • replica_set_count (long or None) – This represents the new value for ‘replicaSetCount’ option which is +the maximum number of ReplicaSets in the namespace. This field is +ignored if +ResourceQuotaOptionsV1Update.replica_set_count_unset is set +to true. +If None, the existing ‘replicaSetCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.replica_set_count_unset is +None or set to false.

    • +

  • replica_set_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.replica_set_count. If this +field is set to true, the existing ‘replicaSetCount’ limit on +the namespace will be reset. If this field is set to false, the +existing replicaset count limit will be changed to the value +specified in +ResourceQuotaOptionsV1Update.replica_set_count, if any. +If None, the existing ‘replicaSetCount’ limit will be changed to +the value specified in +ResourceQuotaOptionsV1Update.replica_set_count, if any.

    • +

  • replication_controller_count (long or None) – This represents the new value for ‘replicationControllerCount’ +option which is the maximum number of ReplicationControllers in the +namespace. This field is ignored if +ResourceQuotaOptionsV1Update.replication_controller_count_unset +is set to true. +If None, the existing ‘replicationControllerCount’ limit will be +unchanged if +ResourceQuotaOptionsV1Update.replication_controller_count_unset +is None or set to false.

    • +

  • replication_controller_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.replication_controller_count. +If this field is set to true, the existing +‘replicationControllerCount’ limit on the namespace will be reset. +If this field is set to false, the existing +replicationcontroller count limit will be changed to the value +specified in +ResourceQuotaOptionsV1Update.replication_controller_count, +if any. +If None, the existing ‘replicationControllerCount’ limit will be +changed to the value specified in +ResourceQuotaOptionsV1Update.replication_controller_count, +if any.

    • +

  • stateful_set_count (long or None) – This represents the new value for ‘statefulSetCount’ option which +is the maximum number of StatefulSets in the namespace. This field +is ignored if +ResourceQuotaOptionsV1Update.stateful_set_count_unset is +set to true. +If None, the existing ‘statefulSetCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.stateful_set_count_unset is +None or set to false.

    • +

  • stateful_set_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.stateful_set_count. If this +field is set to true, the existing ‘statefulSetCount’ limit on +the namespace will be reset. If this field is set to false, the +existing statefulset count limit will be changed to the value +specified in +ResourceQuotaOptionsV1Update.stateful_set_count, if any. +If None, the existing ‘statefulSetCount’ limit will be changed to +the value specified in +ResourceQuotaOptionsV1Update.stateful_set_count, if any.

    • +

  • config_map_count (long or None) – This represents the new value for ‘configMapCount’ option which is +the maximum number of ConfigMaps in the namespace. This field is +ignored if +ResourceQuotaOptionsV1Update.config_map_count_unset is set +to true. +If None, the existing ‘configMapCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.config_map_count_unset is None +or set to false.

    • +

  • config_map_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.config_map_count. If this +field is set to true, the existing ‘configMapCount’ limit on +the namespace will be reset. If this field is set to false, the +existing configmap count limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.config_map_count, +if any. +If None, the existing ‘configMapCount’ limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.config_map_count, if any.

    • +

  • secret_count (long or None) – This represents the new value for ‘secretCount’ option which is the +maximum number of secrets in the namespace. This field is ignored +if ResourceQuotaOptionsV1Update.secret_count_unset is set +to true. +If None, the existing ‘secretCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.secret_count_unset is None or +set to false.

    • +

  • secret_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.secret_count. If this field is +set to true, the existing ‘secretCount’ limit on the namespace +will be reset. If this field is set to false, the existing +secret count limit will be changed to the value specified in +ResourceQuotaOptionsV1Update.secret_count, if any. +If None, the existing ‘secretCount’ limit will be changed to the +value specified in +ResourceQuotaOptionsV1Update.secret_count, if any.

    • +

  • persistent_volume_claim_count (long or None) – This represents the new value for ‘persistentVolumeClaimCount’ +option which is the maximum number of PersistentVolumeClaims in the +namespace. This field is ignored if +ResourceQuotaOptionsV1Update.persistent_volume_claim_count_unset +is set to true. +If None, the existing ‘persistentVolumeClaimCount’ limit will be +unchanged if +ResourceQuotaOptionsV1Update.persistent_volume_claim_count_unset +is None or set to false.

    • +

  • persistent_volume_claim_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.persistent_volume_claim_count. +If this field is set to true, the existing +‘persistentVolumeClaimCount’ limit on the namespace will be reset. +If this field is set to false, the existing +replicationcontroller count limit will be changed to the value +specified in +ResourceQuotaOptionsV1Update.persistent_volume_claim_count, +if any. +If None, the existing ‘persistentVolumeClaimCount’ limit will be +changed to the value specified in +ResourceQuotaOptionsV1Update.persistent_volume_claim_count, +if any.

    • +

  • job_count (long or None) – This represents the new value for ‘jobCount’ option which is the +maximum number of jobs in the namespace. This field is ignored if +ResourceQuotaOptionsV1Update.job_count_unset is set to +true. +If None, the existing ‘jobCount’ limit will be unchanged if +ResourceQuotaOptionsV1Update.job_count_unset is None or set +to false.

    • +

  • job_count_unset (bool or None) – This represents the intent of the change to +ResourceQuotaOptionsV1Update.job_count. If this field is +set to true, the existing ‘jobCount’ limit on the namespace +will be reset. If this field is set to false, the existing +secret count limit will be changed to the value specified in +ResourceQuotaOptionsV1Update.job_count, if any. +If None, the existing ‘jobCount’ limit will be changed to the value +specified in ResourceQuotaOptionsV1Update.job_count, if +any.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespaces_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.ovf_client module

+

The com.vmware.vcenter.ovf_client module provides services to capture and +deploy Open Virtualization Format (OVF) packages to and from the content +library.

+

It provides the ability to deploy OVF packages from the content library with +support for advanced network topologies, network services, creating virtual +appliances and virtual machines in hosts, resource pools or clusters. It also +provides the ability to export virtual appliances and virtual machines from +hosts, resource pools or clusters as OVF packages to the content library.

+
+
+class com.vmware.vcenter.ovf_client.CertificateParams(issuer=None, subject=None, is_valid=None, is_self_signed=None, x509=None, warnings=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CertificateParams class contains information about the public key +certificate used to sign the OVF package. This class will only be returned +if the OVF package is signed.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • issuer (str) – Certificate issuer. For example: /C=US/ST=California/L=Palo +Alto/O=VMware, Inc. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • subject (str) – Certificate subject. For example: +/C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC +Avamar/CN=EMC Corporation. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • is_valid (bool) – Is the certificate chain validated. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • is_self_signed (bool) – Is the certificate self-signed. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • x509 (str) – The X509 representation of the certificate. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • warnings (list of WarningInfo) – The list of warnings raised for the OVF certificate used in this +OVF package deployment. Any warning that is not ignored by the +client will cause the OVF package deployment to fail. This +attribute was added in vSphere API 7.0.2.0. +This attribute is set only if the certificate has warnings when +retrieving information about an OVF package by +LibraryItem.filter(). When the attribute is set, the +WarningInfo.ignored attribute can be updated before the OVF +parameter is passed to LibraryItem.deploy() to deploy the OVF +package.

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.DeploymentOption(key=None, label=None, description=None, default_choice=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DeploymentOption class contains the information about a deployment +option as defined in the OVF specification.

+

This corresponds to the ovf:Configuration element of the +ovf:DeploymentOptionSection in the specification. The +ovf:DeploymentOptionSection specifies a discrete set of intended resource +allocation configurations. This class represents one item from that set.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (str) – The key of the deployment option, corresponding to the ovf:id +attribute in the OVF descriptor. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • label (str) – A localizable label for the deployment option. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • description (str) – A localizable description for the deployment option. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • default_choice (bool) – A bool flag indicates whether this deployment option is +the default choice. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. If None or false, it +is not the default.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.DeploymentOptionParams(deployment_options=None, selected_key=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DeploymentOptionParams class describes the possible deployment +options as well as the choice provided by the user.

+

This information based on the ovf:DeploymentOptionSection.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • deployment_options (list of DeploymentOption) – list of deployment options. This attribute corresponds to +the ovf:Configuration elements of the ovf:DeploymentOptionSection +in the specification. It is a discrete set of intended resource +allocation configurations from which one can be selected. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • selected_key (str) – The selected deployment option. Identifies the +DeploymentOption in the list in the deploymentOptions +attribute with a matching value in the DeploymentOption.key +attribute. +This attribute is optional in the input parameters when deploying +an OVF package. If None the server will use the default deployment +configuration, usually it’s the first one in +DeploymentOptionParams.deployment_options list. +This attribute is optional in the result when retrieving +information about an OVF package. The value will be set only if it +is specified with the optional ovf:default attribute.

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.DiskProvisioningType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DiskProvisioningType class defines the virtual disk provisioning +types that can be set for a disk on the target platform.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DiskProvisioningType instance.

+
+
+
+
+eagerZeroedThick = DiskProvisioningType(string='eagerZeroedThick')
+

An eager zeroed thick provisioned virtual disk has all space allocated and +wiped clean of any previous contents on the physical media at creation +time.

+

Disks specified as eager zeroed thick may take longer time to create than +disks specified with the other disk provisioning types.

+
+ +
+
+thick = DiskProvisioningType(string='thick')
+

A thick provisioned virtual disk has all space allocated at creation time +and the space is zeroed on demand as the space is used.

+
+ +
+
+thin = DiskProvisioningType(string='thin')
+

A thin provisioned virtual disk has space allocated and zeroed on demand as +the space is used.

+
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.ExportFlag(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ExportFlag class provides methods for retrieving information about +the export flags supported by the server. Export flags can be specified in +a LibraryItem.CreateSpec to customize an OVF export.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(option=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ExportFlag.Info class describes an export flag supported by the +server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+list()
+

Returns information about the supported export flags by the server.

+

The supported flags are:

+

PRESERVE_MAC +Include MAC addresses for network adapters. +EXTRA_CONFIG +Include extra configuration in OVF export.

+

Future server versions might support additional flags.

+
+
Return type
+

list of ExportFlag.Info

+
+
Returns
+

A list of supported export flags.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.ExtraConfig(key=None, value=None, virtual_system_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ExtraConfig class contains the information about a vmw:ExtraConfig +element which can be used to specify configuration settings that are +transferred directly to the .vmx file. The behavior of the +vmw:ExtraConfig element is similar to the extraConfig property of the +VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the +same restrictions apply, such as you cannot set values that could otherwise +be set with other properties in the VirtualMachineConfigSpec object. +See the VMware vSphere API reference for details on this.

+

vmw:ExtraConfig elements may occur as direct child elements of a +VirtualHardwareSection, or as child elements of individual virtual hardware +items.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (str) – The key of the ExtraConfig element. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +

  • value (str) – The value of the ExtraConfig element. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +

  • virtual_system_id (str) – The identifier of the virtual system containing the vmw:ExtraConfig +element. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.ExtraConfigParams(extra_configs=None, exclude_keys=None, include_keys=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ExtraConfigParams class contains the parameters with information +about the vmw:ExtraConfig elements in an OVF package.

+

vmw:ExtraConfig elements can be used to specify configuration settings that +are transferred directly to the .vmx file.

+

The behavior of the vmw:ExtraConfig element is similar to the +extraConfig property of the VirtualMachineConfigSpec object in the +VMware vSphere API. Thus, the same restrictions apply, such as you cannot +set values that could otherwise be set with other properties in the +VirtualMachineConfigSpec object. See the VMware vSphere API reference +for details on this.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • extra_configs (list of ExtraConfig) – list of vmw:ExtraConfig elements in the OVF package. +This attribute is optional in the input parameters when deploying +an OVF package. If None there are no extra configuration elements +to use for this OVF package deployment. This attribute will always +be present in the result when retrieving information about an OVF +package. It will be an empty list if there are no extra +configuration elements in the OVF package.

    • +

  • exclude_keys (list of str) –

    Specifies which extra configuration items in the list in +the extraConfigs field should be ignored during deployment.

    +

    If set, the given keys for extra configurations will be ignored +during deployment. The key is defined in the +ExtraConfig.key attribute. +This attribute is optional in the input parameters when deploying +an OVF package. It is an error to set both this and +ExtraConfigParams.include_keys. This attribute is optional +in the result when retrieving information about an OVF package. It +is an error to set both this and +ExtraConfigParams.include_keys.

    +

    • +

  • include_keys (list of str) –

    Specifies which extra configuration items in the list in +the extraConfigs field should be included during +deployment.

    +

    If set, all but the given keys for extra configurations will be +ignored during deployment. The key is defined in the +ExtraConfig.key attribute. +This attribute is optional in the input parameters when deploying +an OVF package. It is an error to set both this and +ExtraConfigParams.exclude_keys. This attribute is optional +in the result when retrieving information about an OVF package. It +is an error to set both this and +ExtraConfigParams.exclude_keys.

    +

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.ImportFlag(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ImportFlag class provides methods for retrieving information about +the import flags supported by the deployment platform. Import flags can be +specified in a LibraryItem.ResourcePoolDeploymentSpec to customize +an OVF deployment.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(option=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ImportFlag.Info class describes an import flag supported by the +deployment platform.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+list(rp)
+

Returns information about the import flags supported by the deployment +platform.

+

The supported flags are:

+

LAX +Lax mode parsing of the OVF descriptor.

+

Future server versions might support additional flags.

+
+
Parameters
+

rp (str) – The identifier of resource pool target for retrieving the import +flag(s). +The parameter must be an identifier for the resource type: +ResourcePool.

+
+
Return type
+

list of ImportFlag.Info

+
+
Returns
+

A list of supported import flags.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the resource pool associated with rp does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource ResourcePool referenced by the parameter rp +requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.IpAllocationParams(supported_allocation_scheme=None, supported_ip_allocation_policy=None, ip_allocation_policy=None, supported_ip_protocol=None, ip_protocol=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IpAllocationParams class specifies how IP addresses are allocated +to OVF properties. In particular, it informs the deployment platform +whether the guest supports IPv4, IPv6, or both. It also specifies whether +the IP addresses can be obtained through DHCP or through the properties +provided in the OVF environment.

+

Ovf Property elements are exposed to the guest software through the OVF +environment. Each Property element exposed in the OVF environment shall be +constructed from the value of the ovf:key attribute. A Property element +contains a key/value pair, it may optionally specify type qualifiers using +the ovf:qualifiers attribute with multiple qualifiers separated by commas.

+

The settings in IpAllocationParams class are global to a deployment. +Thus, if a virtual machine is part of a virtual appliance, then its +settings are ignored and the settings for the virtual appliance is used.

+

This information is based on the vmw:IpAssignmentSection in OVF package.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supported_allocation_scheme (list of IpAllocationParams.IpAllocationScheme) – Specifies the IP allocation schemes supported by the guest +software. This attribute defines the valid values for the IP +allocation policy. This setting is often configured by the virtual +appliance template author or OVF package author to reflect what the +guest software supports, and the IP allocation policy is configured +at deployment time. See +IpAllocationParams.ip_allocation_policy. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • supported_ip_allocation_policy (list of IpAllocationParams.IpAllocationPolicy) – Specifies the IP allocation policies supported. The set of valid +options for the policy is based on the capabilities of the virtual +appliance software, as specified by the +IpAllocationParams.supported_allocation_scheme attribute. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • ip_allocation_policy (IpAllocationParams.IpAllocationPolicy) – Specifies how IP allocation is done through an IP Pool. This is +typically specified by the deployer. +This attribute is optional in the input parameters when deploying +an OVF package. If None there is no IP allocation policy. This +attribute will always be present in the result when retrieving +information about an OVF package.

    • +

  • supported_ip_protocol (list of IpAllocationParams.IpProtocol) – Specifies the IP protocols supported by the guest. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • ip_protocol (IpAllocationParams.IpProtocol) – Specifies the chosen IP protocol for this deployment. This must be +one of the IP protocols supported by the guest software. See +IpAllocationParams.supported_ip_protocol. +This attribute is optional in the input parameters when deploying +an OVF package. If None there is no IP protocol chosen. This +attribute will always be present in the result when retrieving +information about an OVF package.

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+
+class IpAllocationPolicy(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The IpAllocationParams.IpAllocationPolicy class defines the possible IP +allocation policy for a deployment.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpAllocationPolicy instance.

+
+
+
+
+DHCP = IpAllocationPolicy(string='DHCP')
+

Specifies that DHCP will be used to allocate IP addresses.

+
+ +
+
+STATIC_IPPOOL = IpAllocationPolicy(string='STATIC_IPPOOL')
+

Specifies that IP addresses are allocated from the range managed by an IP +pool. The IP addresses are allocated at first power-on, and remain +allocated at power-off. This ensures that a virtual appliance gets a +consistent IP for its life-time.

+
+ +
+
+STATIC_MANUAL = IpAllocationPolicy(string='STATIC_MANUAL')
+

Specifies that IP addresses are configured manually upon deployment, and +will be kept until reconfigured or the virtual appliance destroyed. This +ensures that a property gets a consistent IP for its lifetime.

+
+ +
+
+TRANSIENT_IPPOOL = IpAllocationPolicy(string='TRANSIENT_IPPOOL')
+

Specifies that IP addresses are allocated from an IP pool. The IP addresses +are allocated when needed, typically at power-on, and deallocated during +power-off. There is no guarantee that a property will receive same IP +address when restarted.

+
+ +
+ +
+
+class IpAllocationScheme(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The IpAllocationParams.IpAllocationScheme class defines the possible IP +allocation schemes that can be supported by the guest software.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpAllocationScheme instance.

+
+
+
+
+DHCP = IpAllocationScheme(string='DHCP')
+

It supports DHCP to acquire IP configuration.

+
+ +
+
+OVF_ENVIRONMENT = IpAllocationScheme(string='OVF_ENVIRONMENT')
+

It supports setting the IP configuration through the properties provided in +the OVF environment.

+
+ +
+ +
+
+class IpProtocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The IpAllocationParams.IpProtocol class defines the IP protocols +supported by the guest software.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpProtocol instance.

+
+
+
+
+IPV4 = IpProtocol(string='IPV4')
+

It supports the IPv4 protocol.

+
+ +
+
+IPV6 = IpProtocol(string='IPV6')
+

It supports the IPv6 protocol.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.LibraryItem(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LibraryItem class provides methods to deploy virtual machines and +virtual appliances from library items containing Open Virtualization Format +(OVF) packages in content library, as well as methods to create library +items in content library from virtual machines and virtual appliances.

+

To deploy a virtual machine or a virtual appliance from a library item:

+
    +

  1. Create a LibraryItem.DeploymentTarget to specify the target +deployment type and target deployment designation.

    2. +

  2. Create a LibraryItem.ResourcePoolDeploymentSpec to specify the +parameters for the target deployment.

    3. +

  3. Use the deploy method with the created target and parameter +specifications, along with the identifier of the specified source content +library item. See LibraryItem.deploy().

    4. +
+

To create a library item in content library from a virtual machine or +virtual appliance:

+
    +

  1. Create a LibraryItem.DeployableIdentity to specify the source +virtual machine or virtual appliance to be used as the OVF template source.

    2. +

  2. Create a LibraryItem.CreateTarget to specify the target library +and library item.

    3. +

  3. Create a LibraryItem.CreateSpec to specify the settings for the +OVF package to be created.

    4. +

  4. Use the create method with the created target and parameter +specifications, along with the specified source entity. See +LibraryItem.create().

    5. +
+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateResult(succeeded=None, ovf_library_item_id=None, error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.CreateResult class defines the result of the create +method. See LibraryItem.create().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • succeeded (bool) – Whether the create method completed successfully.

    • +

  • ovf_library_item_id (str or None) – Identifier of the created or updated library item. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +If None, the create method failed and +LibraryItem.CreateResult.error will describe the error(s) +that caused the failure.

    • +

  • error (LibraryItem.ResultInfo or None) – Errors, warnings, and informational messages produced by the +create method. +If None, no errors, warnings, or informational messages were +reported by the create method.

    • +
+
+
+
+ +
+
+class CreateSpec(name=None, description=None, flags=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.CreateSpec class defines the information used to create +or update a library item containing an OVF package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Name to use in the OVF descriptor stored in the library item. +If None, the server will use source’s current name.

    • +

  • description (str or None) – Description to use in the OVF descriptor stored in the library +item. +If None, the server will use source’s current annotation.

    • +

  • flags (list of str or None) – Flags to use for OVF package creation. The supported flags can be +obtained using ExportFlag.list(). +If None, no flags will be used.

    • +
+
+
+
+ +
+
+class CreateTarget(library_id=None, library_item_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.CreateTarget class specifies the target library item +when capturing a virtual machine or virtual appliance as an OVF package in +a library item in a content library. The target can be an existing library +item, which will be updated, creating a new version, or it can be a newly +created library item in a specified library. See +LibraryItem.create().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • library_id (str or None) –

    Identifier of the library in which a new library item should be +created. This attribute is not used if the libraryItemId +attribute is specified. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +This attribute is currently required.

    +

    In the future, if None, the libraryItemId attribute must be +specified.

    +

    • +

  • library_item_id (str or None) – Identifier of the library item that should be should be updated. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item. +If None, a new library item will be created. The libraryId +attribute must be specified if this attribute is set.

    • +
+
+
+
+ +
+
+DEPLOYABLE = ['VirtualMachine', 'VirtualApp']
+

The types of resources that can be created by deploying an OVF package and can +be captured to create a library item using the LibraryItem class.

+
+ +
+
+class DeployableIdentity(type=None, id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.DeployableIdentity class describes the resource created +by a deployment, or the source resource from which library item can be +created, by specifying its resource type and resource identifier.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (str) – Type of the deployable resource. +When clients pass a value of this class as a parameter, the +attribute must be one of VirtualMachine or VirtualApp. When +methods return a value of this class as a return value, the +attribute will be one of VirtualMachine or VirtualApp.

    • +

  • id (str) – Identifier of the deployable resource. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for one of these resource types: +VirtualMachine or VirtualApp. When methods return a value +of this class as a return value, the attribute will be an +identifier for one of these resource types: VirtualMachine or +VirtualApp.

    • +
+
+
+
+ +
+
+class DeploymentResult(succeeded=None, resource_id=None, error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.DeploymentResult class defines the result of the +deploy method. See LibraryItem.deploy().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • succeeded (bool) – Whether the deploy method completed successfully.

    • +

  • resource_id (LibraryItem.DeployableIdentity or None) – Identifier of the deployed resource entity. +If None, the deploy method failed and +LibraryItem.DeploymentResult.error will describe the +error(s) that caused the failure.

    • +

  • error (LibraryItem.ResultInfo or None) – Errors, warnings, and informational messages produced by the +deploy method. +If None, no errors, warnings, or informational messages were +reported by the deploy method.

    • +
+
+
+
+ +
+
+class DeploymentTarget(resource_pool_id=None, host_id=None, folder_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.DeploymentTarget class describes the location (target) +where a virtual machine or virtual appliance should be deployed. It is used +in the deploy and filter methods. See LibraryItem.deploy() +and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • resource_pool_id (str) – Identifier of the resource pool to which the virtual machine or +virtual appliance should be attached. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool.

    • +

  • host_id (str or None) – Identifier of the target host on which the virtual machine or +virtual appliance will run. The target host must be a member of the +cluster that contains the resource pool identified by +LibraryItem.DeploymentTarget.resource_pool_id. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +If None, the server will automatically select a target host from +the resource pool if +LibraryItem.DeploymentTarget.resource_pool_id is a +stand-alone host or a cluster with Distributed Resource Scheduling +(DRS) enabled.

    • +

  • folder_id (str or None) – Identifier of the vCenter folder that should contain the virtual +machine or virtual appliance. The folder must be virtual machine +folder. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +If None, the server will choose the deployment folder.

    • +
+
+
+
+ +
+
+class OvfSummary(name=None, annotation=None, eulas=None, networks=None, storage_groups=None, additional_params=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.OvfSummary class defines the result of the filter +method. See LibraryItem.filter(). The attributes in the class +describe parameterizable information in the OVF descriptor, with respect to +a deployment target, for the deploy method. See +LibraryItem.deploy().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Default name for the virtual machine or virtual appliance. +If None, the OVF descriptor did not specify a name.

    • +

  • annotation (str or None) – Default annotation for the virtual machine or virtual appliance. +If None, the OVF descriptor did not specify an annotation.

    • +

  • eulas (list of str) – End User License Agreements specified in the OVF descriptor. All +end user license agreements must be accepted in order for the +deploy method to succeed. See +LibraryItem.ResourcePoolDeploymentSpec.accept_all_eula.

    • +

  • networks (list of str or None) – Section identifiers for sections of type ovf:NetworkSection in the +OVF descriptor. These identifiers can be used as keys in +LibraryItem.ResourcePoolDeploymentSpec.network_mappings. +If None, the OVF descriptor did not specify any networks.

    • +

  • storage_groups (list of str or None) – Section identifiers for sections of type vmw:StorageGroupSection in +the OVF descriptor. These identifiers can be used as keys in +LibraryItem.ResourcePoolDeploymentSpec.storage_mappings. +If None, the OVF descriptor did not specify any storage groups.

    • +

  • additional_params (list of vmware.vapi.struct.VapiStruct or None) – Additional OVF parameters which can be specified for the deployment +target. These OVF parameters can be inspected, optionally modified, +and used as values in +LibraryItem.ResourcePoolDeploymentSpec.additional_parameters +for the deploy method. +When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +OvfParams. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in OvfParams. +If None, the OVF descriptor does not require addtional parameters +or does not have additional parameters suitable for the deployment +target.

    • +
+
+
+
+ +
+
+class ResourcePoolDeploymentSpec(name=None, annotation=None, accept_all_eula=None, network_mappings=None, storage_mappings=None, storage_provisioning=None, storage_profile_id=None, locale=None, flags=None, additional_parameters=None, default_datastore_id=None, vm_config_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.ResourcePoolDeploymentSpec class defines the deployment +parameters that can be specified for the deploy method where the +deployment target is a resource pool. See LibraryItem.deploy().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Name assigned to the deployed target virtual machine or virtual +appliance. +If None, the server will use the name from the OVF package.

    • +

  • annotation (str or None) – Annotation assigned to the deployed target virtual machine or +virtual appliance. +If None, the server will use the annotation from the OVF package.

    • +

  • accept_all_eula (bool) – Whether to accept all End User License Agreements. See +LibraryItem.OvfSummary.eulas.

    • +

  • network_mappings ((dict of str and str) or None) – Specification of the target network to use for sections of type +ovf:NetworkSection in the OVF descriptor. The key in the +dict is the section identifier of the ovf:NetworkSection +section in the OVF descriptor and the value is the target network +to be used for deployment. +When clients pass a value of this class as a parameter, the value +in the attribute dict must be an identifier for the +resource type: Network. When methods return a value of this +class as a return value, the value in the attribute dict +will be an identifier for the resource type: Network. +If None, the server will choose a network mapping.

    • +

  • storage_mappings ((dict of str and LibraryItem.StorageGroupMapping) or None) – Specification of the target storage to use for sections of type +vmw:StorageGroupSection in the OVF descriptor. The key in the +dict is the section identifier of the +ovf:StorageGroupSection section in the OVF descriptor and the value +is the target storage specification to be used for deployment. See +LibraryItem.StorageGroupMapping. +If None, the server will choose a storage mapping.

    • +

  • storage_provisioning (DiskProvisioningType or None) – Default storage provisioning type to use for all sections of type +vmw:StorageSection in the OVF descriptor. +If None, the server will choose the provisioning type.

    • +

  • storage_profile_id (str or None) – Default storage profile to use for all sections of type +vmw:StorageSection in the OVF descriptor. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +StorageProfile. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: StorageProfile. +If None, the server will choose the default profile.

    • +

  • locale (str or None) – The locale to use for parsing the OVF descriptor. +If None, the server locale will be used.

    • +

  • flags (list of str or None) – Flags to be use for deployment. The supported flag values can be +obtained using ImportFlag.list(). +If None, no flags will be used.

    • +

  • additional_parameters (list of vmware.vapi.struct.VapiStruct or None) –

    Additional OVF parameters that may be needed for the deployment. +Additional OVF parameters may be required by the OVF descriptor of +the OVF package in the library item. Examples of OVF parameters +that can be specified through this attribute include, but are not +limited to:

    + +

    When clients pass a value of this class as a parameter, the +attribute must contain all the attributes defined in +OvfParams. When methods return a value of this class as a +return value, the attribute will contain all the attributes defined +in OvfParams. +If None, the server will choose default settings for all parameters +necessary for the deploy method. See +LibraryItem.deploy().

    +

    • +

  • default_datastore_id (str or None) – Default datastore to use for all sections of type +vmw:StorageSection in the OVF descriptor. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +If None, the server will choose the default datastore.

    • +

  • vm_config_spec (LibraryItem.VmConfigSpec or None) – The LibraryItem.ResourcePoolDeploymentSpec.vm_config_spec +is used for virtual machine configuration settings including +hardware specifications to use in place of the OVF descriptor. If +set, the OVF descriptor acts as a disk descriptor. Fields in the +LibraryItem.ResourcePoolDeploymentSpec parameters such as +LibraryItem.ResourcePoolDeploymentSpec.name that overlap +with settings in the +LibraryItem.ResourcePoolDeploymentSpec.vm_config_spec are +not overridden and will continue to be used. Similarly, storage +settings in the LibraryItem.ResourcePoolDeploymentSpec that +affect the disks on the virtual machine namely +LibraryItem.ResourcePoolDeploymentSpec.storage_mappings, +LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id, +LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning +and +LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id +will also be honored. This attribute was added in vSphere API +8.0.2.0. +If None, the relevant virtual machine specifications in the OVF +descriptor of the OVF template will be used.

    • +
+
+
+
+ +
+
+class ResultInfo(errors=None, warnings=None, information=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.ResultInfo class defines the information returned along +with the result of a create or deploy method to describe errors, +warnings, and informational messages produced by the server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • errors (list of OvfError) – Errors reported by the create or deploy method. These +errors would have prevented the create or deploy method +from completing successfully.

    • +

  • warnings (list of OvfWarning) – Warnings reported by the create or deploy method. These +warnings would not have prevented the create or deploy +method from completing successfully, but there might be issues that +warrant attention.

    • +

  • information (list of OvfInfo) – Information messages reported by the create or deploy +method. For example, a non-required parameter was ignored.

    • +
+
+
+
+ +
+
+class StorageGroupMapping(type=None, datastore_id=None, storage_profile_id=None, provisioning=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.StorageGroupMapping class defines the storage +deployment target and storage provisioning type for a section of type +vmw:StorageGroupSection in the OVF descriptor.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LibraryItem.StorageGroupMapping.Type) – Type of storage deployment target to use for the +vmw:StorageGroupSection section. The specified value must be +LibraryItem.StorageGroupMapping.Type.DATASTORE or +LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE.

    • +

  • datastore_id (str) – Target datastore to be used for the storage group. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is optional and it is only relevant when the value +of type is +LibraryItem.StorageGroupMapping.Type.DATASTORE.

    • +

  • storage_profile_id (str) – Target storage profile to be used for the storage group. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +StorageProfile. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: StorageProfile. +This attribute is optional and it is only relevant when the value +of type is +LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE.

    • +

  • provisioning (DiskProvisioningType or None) – Target provisioning type to use for the storage group. +If None, +LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning +will be used.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LibraryItem.StorageGroupMapping.Type class defines the supported +types of storage targets for sections of type vmw:StorageGroupSection in +the OVF descriptor.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DATASTORE = Type(string='DATASTORE')
+

Storage deployment target is a datastore.

+
+ +
+
+STORAGE_PROFILE = Type(string='STORAGE_PROFILE')
+

Storage deployment target is a storage profile.

+
+ +
+ +
+ +
+
+class VmConfigSpec(provider=None, xml=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.VmConfigSpec defines the optional virtual machine +configuration settings used when deploying an OVF template. When used, the +OVF descriptor acts as a disk descriptor. This class was added in vSphere +API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (LibraryItem.VmConfigSpecProvider) – The LibraryItem.VmConfigSpec.provider selects a provider +from the list of available providers. This attribute was added in +vSphere API 8.0.2.0.

    • +

  • xml (str) – The LibraryItem.VmConfigSpec.xml is a conditional +configuration made available upon selecting the +LibraryItem.VmConfigSpecProvider.XML. It is used to pass in +a vim.vm.ConfigSpec for a virtual machine that has been serialized +to XML and base64 encoded. This attribute was added in vSphere API +8.0.2.0. +This attribute is optional and it is only relevant when the value +of provider is LibraryItem.VmConfigSpecProvider.XML.

    • +
+
+
+
+ +
+
+class VmConfigSpecProvider(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LibraryItem.VmConfigSpecProvider is used to provide the optional +LibraryItem.VmConfigSpec used when deploying an OVF template. This +enumeration was added in vSphere API 8.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the VmConfigSpecProvider instance.

+
+
+
+
+XML = VmConfigSpecProvider(string='XML')
+

A vim.vm.ConfigSpec that has been serialized to XML and base64 encoded. +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+ +
+
+create(source, target, create_spec, client_token=None)
+

Creates a library item in content library from a virtual machine or +virtual appliance.

+

This method creates a library item in content library whose content is +an OVF package derived from a source virtual machine or virtual +appliance, using the supplied create specification. The OVF package may +be stored as in a newly created library item or in an in an existing +library item. For an existing library item whose content is updated by +this method, the original content is overwritten. Meta data such as +name and description is not updated for the exisitng library item.

+
+
Parameters
+
    +

  • client_token (str or None) – Client-generated token used to retry a request if the client fails +to get a response from the server. If the original request +succeeded, the result of that request will be returned, otherwise +the operation will be retried. +If None, the server will create a token.

    • +

  • source (LibraryItem.DeployableIdentity) – Identifier of the virtual machine or virtual appliance to use as +the source.

    • +

  • target (LibraryItem.CreateTarget) – Specification of the target content library and library item.

    • +

  • create_spec (LibraryItem.CreateSpec) – Information used to create the OVF package from the source virtual +machine or virtual appliance.

    • +
+
+
Return type
+

LibraryItem.CreateResult

+
+
Returns
+

Information about the success or failure of the method, along with +the details of the result or failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if create_spec contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if source describes an unexpected resource type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual appliance specified by source +does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library or library item specified by target does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation cannot be performed because of the specified +virtual machine or virtual appliance’s current state. For example, +if the virtual machine configuration information is not available, +or if the virtual appliance is running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there was an error accessing a file from the source virtual +machine or virtual appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the specified virtual machine or virtual appliance is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource VirtualMachine or VirtualApp referenced by +the attribute LibraryItem.DeployableIdentity.id requires +VApp.Export.

    • +

  • The resource com.vmware.content.Library referenced by the +attribute LibraryItem.CreateTarget.library_id requires +ContentLibrary.AddLibraryItem.

    • +

  • The resource com.vmware.content.library.Item referenced by +the attribute LibraryItem.CreateTarget.library_item_id +requires System.Read.

    • +
+
+
+
+ +
+
+deploy(ovf_library_item_id, target, deployment_spec, client_token=None)
+

Deploys an OVF package stored in content library to a newly created +virtual machine or virtual appliance.

+

This method deploys an OVF package which is stored in the library item +specified by ovf_library_item_id. It uses the deployment +specification in deployment_spec to deploy the OVF package to the +location specified by target.

+
+
Parameters
+
    +

  • client_token (str or None) – Client-generated token used to retry a request if the client fails +to get a response from the server. If the original request +succeeded, the result of that request will be returned, otherwise +the operation will be retried. +If None, the server will create a token.

    • +

  • ovf_library_item_id (str) – Identifier of the content library item containing the OVF package +to be deployed. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • target (LibraryItem.DeploymentTarget) – Specification of the deployment target.

    • +

  • deployment_spec (LibraryItem.ResourcePoolDeploymentSpec) – Specification of how the OVF package should be deployed to the +target.

    • +
+
+
Return type
+

LibraryItem.DeploymentResult

+
+
Returns
+

Information about the success or failure of the method, along with +the details of the result or failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if target contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if deployment_spec contains invalid arguments or has attributes +that are inconsistent with target.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by ovf_library_item_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any resource specified by a attribute of the +LibraryItem.DeploymentTarget class, specified by +target, does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there was an error accessing the OVF package stored in the +library item specified by ovf_library_item_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows :

+
    +

  • Method execution requires VirtualMachine.Config.AddNewDisk if the +OVF descriptor has a disk drive (type 17) section.

    • +

  • Method execution requires VirtualMachine.Config.AdvancedConfig if +the OVF descriptor has an ExtraConfig section.

    • +

  • Method execution requires Extension.Register for specified +resource group if the OVF descriptor has a vServiceDependency +section.

    • +

  • Method execution requires Network.Assign for target network if +specified.

    • +

  • Method execution requires Datastore.AllocateSpace for target +datastore if specified.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter ovf_library_item_id requires System.Read.

    • +

  • The resource HostSystem referenced by the attribute +LibraryItem.DeploymentTarget.host_id requires +System.Read.

    • +

  • The resource Network referenced by the dict value of +attribute +LibraryItem.ResourcePoolDeploymentSpec.network_mappings +requires System.Read.

    • +

  • The resource StorageProfile referenced by the attribute +LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id +requires System.Read.

    • +

  • The resource Datastore referenced by the attribute +LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id +requires System.Read.

    • +

  • The resource ResourcePool referenced by the attribute +LibraryItem.DeploymentTarget.resource_pool_id requires +VApp.Import.

    • +

  • The resource Folder referenced by the attribute +LibraryItem.DeploymentTarget.folder_id requires +VApp.Import.

    • +
+
+
+
+ +
+
+filter(ovf_library_item_id, target)
+

Queries an OVF package stored in content library to retrieve +information to use when deploying the package. See +LibraryItem.deploy().

+

This method retrieves information from the descriptor of the OVF +package stored in the library item specified by +ovf_library_item_id. The information returned by the method can be +used to populate the deployment specification (see +LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF +package to the deployment target specified by target.

+
+
Parameters
+
    +

  • ovf_library_item_id (str) – Identifier of the content library item containing the OVF package +to query. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • target (LibraryItem.DeploymentTarget) – Specification of the deployment target.

    • +
+
+
Return type
+

LibraryItem.OvfSummary

+
+
Returns
+

Information that can be used to populate the deployment +specification (see LibraryItem.ResourcePoolDeploymentSpec) +when deploying the OVF package to the deployment target specified +by target.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if target contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by ovf_library_item_id does not +exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any resource specified by a attribute of the +LibraryItem.DeploymentTarget class, specified by +target, does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there was an error accessing the OVF package at the specified +ovf_library_item_id.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter ovf_library_item_id requires System.Read.

    • +

  • The resource ResourcePool referenced by the attribute +LibraryItem.DeploymentTarget.resource_pool_id requires +System.Read.

    • +

  • The resource HostSystem referenced by the attribute +LibraryItem.DeploymentTarget.host_id requires +System.Read.

    • +

  • The resource Folder referenced by the attribute +LibraryItem.DeploymentTarget.folder_id requires +System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.OvfError(category=None, issues=None, name=None, value=None, message=None, error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OvfError class describes an error related to accessing, validating, +deploying, or exporting an OVF package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.OvfInfo(messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OvfInfo class contains informational messages related to accessing, +validating, deploying, or exporting an OVF package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

messages (list of com.vmware.vapi.std_client.LocalizableMessage) – A list of localizable messages (see +com.vmware.vapi.std_client.LocalizableMessage).

+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.OvfMessage(category=None, issues=None, name=None, value=None, message=None, error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OvfMessage class describes a base OVF handling error message +related to accessing, validating, deploying, or exporting an OVF package.

+

These messages fall into different categories defined in +OvfMessage.Category:

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Category(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The OvfMessage.Category class defines the categories of messages (see +OvfMessage).

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Category instance.

+
+
+
+
+INPUT = Category(string='INPUT')
+

The user provided input parameters are invalid.

+
+ +
+
+SERVER = Category(string='SERVER')
+

Server error.

+
+ +
+
+VALIDATION = Category(string='VALIDATION')
+

The OVF descriptor is invalid, for example, syntax errors or schema errors.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.OvfParams(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OvfParams class defines the common attributes for all OVF +deployment parameters. OVF parameters serve several purposes:

+
    +

  • Describe information about a given OVF package.

    • +

  • Describe default deployment configuration.

    • +

  • Describe possible deployment values based on the deployment environment.

    • +

  • Provide deployment-specific configuration.

    • +
+

Each OVF parameters class specifies a particular configurable aspect of OVF +deployment. An aspect has both a query-model and a deploy-model. The +query-model is used when the OVF package is queried, and the deploy-model +is used when deploying an OVF package.

+

Most OVF parameter classes provide both informational and deployment +parameters. However, some are purely informational (for example, download +size) and some are purely deployment parameters (for example, the flag to +indicate whether registration as a vCenter extension is accepted).

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.OvfWarning(category=None, issues=None, name=None, value=None, message=None, error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The OvfWarning class describes a warning related to accessing, +validating, deploying, or exporting an OVF package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.ParseIssue(category=None, file=None, line_number=None, column_number=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ParseIssue class contains the information about the issue found +when parsing an OVF package during deployment or exporting an OVF package +including:

+
    +

  • Parsing and validation error on OVF descriptor (which is an XML +document), manifest and certificate files.

    • +

  • OVF descriptor generating and device error.

    • +

  • Unexpected server error.

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • category (ParseIssue.Category) – The category of the parse issue.

    • +

  • file (str) – The name of the file in which the parse issue was found.

    • +

  • line_number (long) – The line number of the line in the file (see +ParseIssue.file) where the parse issue was found (or -1 if +not applicable).

    • +

  • column_number (long) – The position in the line (see ParseIssue.line_number) (or +-1 if not applicable).

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message describing the parse issue.

    • +
+
+
+
+
+class Category(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ParseIssue.Category class defines the categories of issues that can +be found when parsing files inside an OVF package (see ParseIssue) +including OVF descriptor (which is an XML document), manifest and +certificate files, or exporting an OVF package.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Category instance.

+
+
+
+
+ATTRIBUTE_ILLEGAL = Category(string='ATTRIBUTE_ILLEGAL')
+

Illegal attribute error. It indicates that an illegal attribute is set for +an element in the OVF descriptor. For example, empty disks do not use +format, parentRef, and populatedSize attributes, if these attributes are +present in an empty disk element then will get this pasrse issue.

+
+ +
+
+ATTRIBUTE_REQUIRED = Category(string='ATTRIBUTE_REQUIRED')
+

Required attribute error. It indicates that a required attribute is missing +from an element in the OVF descriptor.

+
+ +
+
+ELEMENT_ILLEGAL = Category(string='ELEMENT_ILLEGAL')
+

Illegal element error. It indicates that an element is present in a +location which is not allowed, or found multiple elements but only one is +allowed at the location in the OVF descriptor.

+
+ +
+
+ELEMENT_REQUIRED = Category(string='ELEMENT_REQUIRED')
+

Required element error. It indicates that a required element is missing +from the OVF descriptor.

+
+ +
+
+ELEMENT_UNKNOWN = Category(string='ELEMENT_UNKNOWN')
+

Unknown element error. It indicates that an element is unsupported when +parsing an OVF descriptor.

+
+ +
+
+EXPORT_ERROR = Category(string='EXPORT_ERROR')
+

Issue during OVF export, for example, malformed deviceId, controller not +found, or file backing for a device not found.

+
+ +
+
+GENERATE_ERROR = Category(string='GENERATE_ERROR')
+

OVF descriptor (which is an XML document) generating error, for example, +well-formedness errors as well as unexpected processing conditions.

+
+ +
+
+INTERNAL_ERROR = Category(string='INTERNAL_ERROR')
+

Server encountered an unexpected error which prevented it from fulfilling +the request.

+
+ +
+
+PARSE_ERROR = Category(string='PARSE_ERROR')
+

OVF package parsing error, including:

+
    +

  • OVF descriptor parsing errors, for example, syntax errors or schema +errors.

    • +

  • Manifest file parsing and verification errors.

    • +

  • Certificate file parsing and verification errors.

    • +
+
+ +
+
+SECTION_RESTRICTION = Category(string='SECTION_RESTRICTION')
+

Section restriction error. It indicates that a section appears in place in +the OVF descriptor where it is not allowed, a section appears fewer times +than is required, or a section appears more times than is allowed.

+
+ +
+
+SECTION_UNKNOWN = Category(string='SECTION_UNKNOWN')
+

Section unknown error. It indicates that a section is unsupported when +parsing an OVF descriptor.

+
+ +
+
+VALIDATION_ERROR = Category(string='VALIDATION_ERROR')
+

An issue with the manifest and signing.

+
+ +
+
+VALUE_ILLEGAL = Category(string='VALUE_ILLEGAL')
+

Illegal value error. For example, the value is malformed, not a number, or +outside of the given range, and so on.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.ovf_client.Property(class_id=None, id=None, instance_id=None, category=None, ui_optional=None, label=None, description=None, type=None, value=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Property class contains the information about a property in an OVF +package.

+

A property is uniquely identified by its [classid.]id[.instanceid] +fully-qualified name (see Property.class_id, Property.id, +and Property.instance_id). If multiple properties in an OVF package +have the same fully-qualified name, then the property is excluded and +cannot be set. We do warn about this during import.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • class_id (str) – The classId of this OVF property. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • id (str) – The identifier of this OVF property. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +

  • instance_id (str) – The instanceId of this OVF property. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • category (str) – If this is set to a non-empty string, this property starts a new +category. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. If None, the property +is in the same category as the previous item, otherwise, it starts +a new category.

    • +

  • ui_optional (bool) –

    Whether a category is UI optional. This is only used if this +property starts a new category (see Property.category).

    +

    The value is stored in an optional attribute vmw:uioptional to the +ovf:Category element. The default value is false. If this value is +true, the properties within this category are optional. The UI +renders this as a group with a check box, and the group is grayed +out until the check box is selected. When the check box is +selected, the input values are read and used in deployment. If +properties within the same category specify conflicting values the +default is used. Only implemented in vSphere Web Client 5.1 and +later as of Nov 2012. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package.

    +

    • +

  • label (str) – The display name of this OVF property. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • description (str) – A description of this OVF property. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package.

    • +

  • type (str) – The type of this OVF property. Refer to the configuration of a +virtual appliance/virtual machine for the valid values. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • value (str) – The OVF property value. This contains the default value from +ovf:defaultValue if ovf:value is not present when read. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.PropertyParams(properties=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PropertyParams class contains a list of OVF properties +that can be configured when the OVF package is deployed.

+

This is based on the ovf:ProductSection.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • properties (list of Property) – list of OVF properties. +This attribute is optional in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.ScaleOutGroup(id=None, description=None, instance_count=None, minimum_instance_count=None, maximum_instance_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ScaleOutGroup class contains information about a scale-out group.

+

It allows a virtual system collection to contain a set of children that are +homogeneous with respect to a prototypical virtual system or virtual system +collection. It shall cause the deployment function to replicate the +prototype a number of times, thus allowing the number of instantiated +virtual systems to be configured dynamically at deployment time.

+

This is based on the ovf2:ScaleOutSection.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The identifier of the scale-out group. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +

  • description (str) – The description of the scale-out group. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • instance_count (long) – The scaling factor to use. It defines the number of replicas of the +prototypical virtual system or virtual system collection. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +

  • minimum_instance_count (long) – The minimum scaling factor. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package. This will be 1 if +there is no explicit limit.

    • +

  • maximum_instance_count (long) – The maximum scaling factor. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. This will be None if +there is no explicit limit.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.ScaleOutParams(groups=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ScaleOutParams class contains information about the scale-out +groups described in the OVF package.

+

When deploying an OVF package, a deployment specific instance count can be +specified (see ScaleOutGroup.instance_count.

+

This is based on the ovf2:ScaleOutSection.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • groups (list of ScaleOutGroup) – The list of scale-out groups. +This attribute is optional in the input parameters when deploying +an OVF package. If None there are no scale-out groups. This +attribute will always be present in the result when retrieving +information about an OVF package.

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.SizeParams(approximate_download_size=None, approximate_flat_deployment_size=None, approximate_sparse_deployment_size=None, variable_disk_size=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SizeParams class contains estimates of the download and deployment +sizes.

+

This information is based on the file references and the ovf:DiskSection in +the OVF descriptor.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • approximate_download_size (long) –

    A best guess as to the total amount of data that must be +transferred to download the OVF package.

    +

    This may be inaccurate due to disk compression etc. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. It will be None if +there is insufficient information to provide a proper estimate.

    +

    • +

  • approximate_flat_deployment_size (long) – A best guess as to the total amount of space required to deploy the +OVF package if using flat disks. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. It will be None if +there is insufficient information to provide a proper estimate.

    • +

  • approximate_sparse_deployment_size (long) – A best guess as to the total amount of space required to deploy the +OVF package using sparse disks. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. It will be None if +there is insufficient information to provide a proper estimate.

    • +

  • variable_disk_size (bool) –

    Whether the OVF uses variable disk sizes.

    +

    For empty disks, rather than specifying a fixed virtual disk +capacity, the capacity may be given using a reference to a +ovf:Property element in a ovf:ProductSection element in OVF +package. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute is optional in the result when +retrieving information about an OVF package. If None or false, the +OVF does not use variable disk sizes.

    +

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.UnknownSection(tag=None, info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UnknownSection class contains information about an unknown section +in an OVF package.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • tag (str) – A namespace-qualified tag in the form {ns}tag.

    • +

  • info (str) – The description of the Info element.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.UnknownSectionParams(unknown_sections=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The UnknownSectionParams class contains a list of unknown, +non-required sections.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • unknown_sections (list of UnknownSection) – list of unknown, non-required sections. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.VcenterExtensionParams(required=None, registration_accepted=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VcenterExtensionParams class specifies that the OVF package should +be registered as a vCenter extension. The virtual machine or virtual +appliance will gain unrestricted access to the vCenter Server APIs. It must +be connected to a network with connectivity to the vCenter server.

+

See LibraryItem.deploy() and LibraryItem.filter().

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • required (bool) – Whether registration as a vCenter extension is required. +This attribute is not used in the input parameters when deploying +an OVF package. This attribute will always be present in the result +when retrieving information about an OVF package.

    • +

  • registration_accepted (bool) –

    Whether registration as a vCenter extension is accepted.

    +

    If registration as a vCenter extension is required (see +VcenterExtensionParams.required), this must be set to true +during deployment. Defaults to false when returned from server. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    +

    • +

  • type (str) – Unique identifier describing the type of the OVF parameters. The +value is the name of the OVF parameters class. +This attribute must be provided in the input parameters when +deploying an OVF package. This attribute will always be present in +the result when retrieving information about an OVF package.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.WarningInfo(type=None, message=None, ignored=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The WarningInfo class provides information about the warnings which are +raised during the OVF package deployment. This class was added in vSphere +API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (WarningType) – The warning type raised during the OVF package deployment. This +attribute was added in vSphere API 7.0.2.0.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The message specifying more details about the warning. This +attribute was added in vSphere API 7.0.2.0.

    • +

  • ignored (bool) –

    Indicates if this warning will be ignored when deploying the OVF +package.

    +

    The value is set to be false when it is returned from +LibraryItem.filter(), it should be updated to be true +when calling LibraryItem.deploy() if the warning can be +ignored, otherwise the OVF package deployment will fail.. This +attribute was added in vSphere API 7.0.2.0.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.ovf_client.WarningType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The WarningType class defines the warnings which can be raised during +the OVF package deployment. This enumeration was added in vSphere API +7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the WarningType instance.

+
+
+
+
+EXPIRED_CERTIFICATE = WarningType(string='EXPIRED_CERTIFICATE')
+

The certificate used for signing the OVF package content is expired. This +class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+NOT_YET_VALID_CERTIFICATE = WarningType(string='NOT_YET_VALID_CERTIFICATE')
+

The certificate used for signing the OVF package content is not yet valid. +This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+SELF_SIGNED_CERTIFICATE = WarningType(string='SELF_SIGNED_CERTIFICATE')
+

The certificate used for signing the OVF package content is self-signed. +This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+UNTRUSTED_CERTIFICATE = WarningType(string='UNTRUSTED_CERTIFICATE')
+

The certificate used for signing the OVF package content is not trusted. +This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+

com.vmware.vcenter.services_client module

+
+
+class com.vmware.vcenter.services_client.Service(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Service class provides methods to manage a single/set of vCenter +Server services. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service.Health class defines the possible values for health of a +service. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+DEGRADED = Health(string='DEGRADED')
+

Service is in degraded state, it is not functional. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+HEALTHY = Health(string='HEALTHY')
+

Service is in a healthy state and is fully functional. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+HEALTHY_WITH_WARNINGS = Health(string='HEALTHY_WITH_WARNINGS')
+

Service is healthy with warnings. This class attribute was added in vSphere +API 6.7.

+
+ +
+ +
+
+class Info(name_key=None, description_key=None, startup_type=None, state=None, health=None, health_messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Service.Info class contains information about a service. This class +was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name_key (str) – Service name key. Can be used to lookup resource bundle. This +attribute was added in vSphere API 6.7.

    • +

  • description_key (str) – Service description key. Can be used to lookup resource bundle. +This attribute was added in vSphere API 6.7.

    • +

  • startup_type (Service.StartupType) – Startup Type. This attribute was added in vSphere API 6.7.

    • +

  • state (Service.State) – Running State. This attribute was added in vSphere API 6.7.

    • +

  • health (Service.Health) – Health of service. This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of state is Service.State.STARTED.

    • +

  • health_messages (list of com.vmware.vapi.std_client.LocalizableMessage) – Localizable messages associated with the health of the service. +This attribute was added in vSphere API 6.7. +This attribute is optional and it is only relevant when the value +of state is Service.State.STARTED.

    • +
+
+
+
+ +
+
+class StartupType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service.StartupType class defines valid Startup Type for vCenter +Server services. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StartupType instance.

+
+
+
+
+AUTOMATIC = StartupType(string='AUTOMATIC')
+

Service Startup type is Automatic, thus during starting all services or +issuing explicit start on the service will start it. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+DISABLED = StartupType(string='DISABLED')
+

Service Startup type is Disabled, thus it will not start unless the startup +type changes to manual or automatic. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+MANUAL = StartupType(string='MANUAL')
+

Service Startup type is Manual, thus issuing an explicit start on the +service will start it. This class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Service.State class defines valid Run State for services. This +enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+STARTED = State(string='STARTED')
+

Service Run State is Started, it is fully functional. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+STARTING = State(string='STARTING')
+

Service Run State is Starting, it is still not functional. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+STOPPED = State(string='STOPPED')
+

Service Run State is Stopped. This class attribute was added in vSphere API +6.7.

+
+ +
+
+STOPPING = State(string='STOPPING')
+

Service Run State is Stopping, it is not functional. This class attribute +was added in vSphere API 6.7.

+
+ +
+ +
+
+class UpdateSpec(startup_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Service.UpdateSpec class describes the changes to be made to the +configuration of the service. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

startup_type (Service.StartupType or None) – Startup Type. This attribute was added in vSphere API 6.7. +If unspecified, leaves value unchanged.

+
+
+
+ +
+
+get(service)
+

Returns the state of a service. This method was added in vSphere API +6.7.

+
+
Parameters
+

service (str) – identifier of the service whose state is being queried. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.services.Service.

+
+
Return type
+

Service.Info

+
+
Returns
+

Service Info structure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+list_details()
+

Lists details of vCenter services. This method was added in vSphere API +6.7.

+
+
Return type
+

dict of str and Service.Info

+
+
Returns
+

Map of service identifiers to service Info structures. +The key in the return value dict will be an identifier for +the resource type: com.vmware.vcenter.services.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any error occurs during the execution of the operation.

+
+
+
+ +
+
+restart(service)
+

Restarts a service. This method was added in vSphere API 6.7.

+
+
Parameters
+

service (str) – identifier of the service to restart +The parameter must be an identifier for the resource type: +com.vmware.vcenter.services.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if any timeout occurs during the execution of the restart +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop or start operation is in progress, issuing a restart +operation will lead to this error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a restart operation is issued on a service which has startup +type Service.StartupType.DISABLED

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+start(service)
+

Starts a service. This method was added in vSphere API 6.7.

+
+
Parameters
+

service (str) – identifier of the service to start +The parameter must be an identifier for the resource type: +com.vmware.vcenter.services.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop or restart operation is in progress, the start operation +will not be allowed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if start operation is issued on a service which has startup type +Service.StartupType.DISABLED.

+
+
Raise
+

com.vmware.vapi.std.errors_client.TimedOut +if any timeout occurs during the execution of the start operation. +Timeout occurs when the service takes longer than StartTimeout to +start.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
+
+ +
+
+stop(service)
+

Stops a service. This method was added in vSphere API 6.7.

+
+
Parameters
+

service (str) – identifier of the service to stop +The parameter must be an identifier for the resource type: +com.vmware.vcenter.services.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a stop operation is in progress, issuing another stop operation +will lead to this error.

+
+
+
+ +
+
+update(service, spec)
+

Updates the properties of a service. This method was added in vSphere +API 6.7.

+
+
Parameters
+
    +

  • service (str) – identifier of the service whose properties are being updated. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.services.Service.

    • +

  • spec (Service.UpdateSpec) – Service Update specification.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the service associated with service does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs during the execution of the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation is denied in the current state of the service. If +a start, stop or restart operation is in progress, update operation +will fail with this error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a request to set the Service.UpdateSpec.startup_type +attribute of spec to Service.StartupType.DISABLED comes +in for a service that is not in Service.State.STOPPED +state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.services_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.storage_client module

+
+
+class com.vmware.vcenter.storage_client.Policies(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Policies class provides methods for managing the storage policies. +This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CompatibilityInfo(compatible_datastores=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policies.CompatibilityInfo class contains info about a list of +datastores compatible with a specific storage policy. This class was added +in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

compatible_datastores (list of Policies.CompatibleDatastoreInfo) – Info about a list of datastores compatible with a specific storage +policy. This attribute was added in vSphere API 6.7.

+
+
+
+ +
+
+class CompatibleDatastoreInfo(datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policies.CompatibleDatastoreInfo class contains compatible +datastore’s information. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

datastore (str) – Identifier of the datastore. This attribute was added in vSphere +API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore.

+
+
+
+ +
+
+class FilterSpec(policies=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policies.FilterSpec class contains attributes used to filter the +results when listing the storage policies (see Policies.list()). This +class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

policies (set of str or None) – Identifiers of storage policies that can match the filter. This +attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.StoragePolicy. +If None or empty, storage policies with any identifiers match the +filter.

+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.StoragePolicy'
+

Resource type for vAPI metadata policy. This class attribute was added in +vSphere API 6.7.

+
+ +
+
+class Summary(policy=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policies.Summary class contains commonly used information about a +storage policy. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • policy (str) – Identifier of the storage policy. This attribute was added in +vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy.

    • +

  • name (str) – Name of the storage policy. This attribute was added in vSphere API +6.7.

    • +

  • description (str) – Description of the storage policy. This attribute was added in +vSphere API 6.7.

    • +
+
+
+
+ +
+
+check_compatibility(policy, datastores)
+

Returns datastore compatibility summary about a specific storage +policy. This method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • policy (str) – The storage policy identifier +The parameter must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy.

    • +

  • datastores (set of str) – Datastores used to check compatibility against a storage policy. +The number of datastores is limited to 1024. +The parameter must contain identifiers for the resource type: +Datastore.

    • +
+
+
Return type
+

Policies.CompatibilityInfo

+
+
Returns
+

datastore compatibility summary about a specific storage policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the storage policy specified does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if input more than 1024 datastores.

+
+
+
+ +
+
+list(filter=None)
+

Returns information about at most 1024 visible (subject to permission +checks) storage solicies availabe in vCenter. These storage policies +can be used for provisioning virtual machines or disks. This method was +added in vSphere API 6.7.

+
+
Parameters
+

filter (Policies.FilterSpec or None) – Specification of matching storage policies for which information +should be returned. +If None, the behavior is equivalent to a +Policies.FilterSpec with all attributes None which means +all storage policies match the filter

+
+
Return type
+

list of Policies.Summary

+
+
Returns
+

Commonly used Information about the storage policies.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Policies.FilterSpec contains a value that is not +supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1024 storage policies exist.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.storage_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.system_config_client module

+
+
+class com.vmware.vcenter.system_config_client.DeploymentType(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DeploymentType class provides methods to get/set the type of the +appliance. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DeploymentType.Info class contains the fields used to get the +appliance type. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (com.vmware.vcenter.deployment_client.ApplianceType) – The type of the appliance. This attribute was added in vSphere API +6.7.

+
+
+
+ +
+
+class ReconfigureSpec(type=None, remote_psc=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DeploymentType.ReconfigureSpec class contains the fields used to +get and set the appliance type. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+get()
+

Get the type of the vCenter appliance. This method was added in vSphere +API 6.7.

+
+
Return type
+

DeploymentType.Info

+
+
Returns
+

The type of the vCenter appliance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if appliance is not in CONFIGURED state.

+
+
+
+ +
+
+reconfigure(spec)
+

Reconfigure the type of the vCenter appliance. This method was added in +vSphere API 6.7.

+
+
Parameters
+

spec (DeploymentType.ReconfigureSpec) – ReconfigureSpec to set the appliance type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the appliance is in CONFIGURED state and if not changing the +type from VCSA_EMBEDDED to VCSA_EXTERNAL.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if external PSC credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is not in INITIALIZED or CONFIGURED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.system_config_client.PscRegistration(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The PscRegistration class provides methods to get and set the +PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with. This +class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(address=None, https_port=None, sso_domain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PscRegistration.Info class has fields to specify information about +the PSC node. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – The IP address or DNS resolvable name of the PSC this appliance is +registered with. This attribute was added in vSphere API 6.7.

    • +

  • https_port (long) – The HTTPs port used by the external PSC. This attribute was added +in vSphere API 6.7.

    • +

  • sso_domain (str) – The Single Sign-On domain name of the external PSC. This attribute +was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+get()
+

Get information of the PSC that this appliance is registered with. This +method was added in vSphere API 6.7.

+
+
Return type
+

PscRegistration.Info

+
+
Returns
+

Info structure containing information about the external PSC node +this appliance is registered with.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is in NOT_INITIALIZED state.

+
+
+
+ +
+
+repoint(spec)
+

Repoint this vCenter Server appliance to a different external PSC. This +method was added in vSphere API 6.7.

+
+
Parameters
+

spec (com.vmware.vcenter.deployment_client.RemotePscSpec) – RemotePscSpec structure containing information about the external +PSC node to repoint this vCenter Server appliance to.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the passed external PSC credentials is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the passed external PSC is not a replicating with the current +PSC this appliance is registered with.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if passed arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the current appliance is not of the type VCSA_EXTERNAL.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the appliance is NOT in CONFIGURED state.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.system_config_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.tagging_client module

+

The com.vmware.vcenter.tagging_client module provides classes for managing +tags.

+
+
+class com.vmware.vcenter.tagging_client.Associations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Associations class provides methods to list tag associations. This +class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class IterationSpec(marker=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Associations.IterationSpec class contains attributes used to break +results into pages when listing tags associated to objects see +Associations.list()). This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

marker (str or None) – Marker is an opaque token that allows the caller to request the +next page of tag associations. This attribute was added in vSphere +API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.tagging.associations.Marker. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.tagging.associations.Marker. +If None or empty, first page of tag associations will be returned.

+
+
+
+ +
+
+class LastIterationStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The last status for the iterator. A field of this type is returned as part +of the result and indicates to the caller of the API whether it can +continue to make requests for more data.

+

The last status only reports on the state of the iteration at the time data +was last returned. As a result, it not does guarantee if the next call will +succeed in getting more data or not.

+

Failures to retrieve results will be returned as Error responses. These +last statuses are only returned when the iterator is operating as +expected.. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LastIterationStatus instance.

+
+
+
+
+END_OF_DATA = LastIterationStatus(string='END_OF_DATA')
+

Iterator has finished iterating through its inventory. There are currently +no more entities to return and the caller can terminate iteration. If the +iterator returned some data, the marker may be set to allow the iterator to +continue from where it left off when additional data does become available. +This value is used to indicate that all available data has been returned by +the iterator. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+READY = LastIterationStatus(string='READY')
+

Iterator has more data pending and is ready to provide it. The caller can +request the next page of data at any time.

+

The number of results returned may be less than the usual size. In other +words, the iterator may not fill the page. The iterator has returned at +least 1 result.. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class ListResult(associations=None, marker=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Associations.ListResult class contains the list of tag associations +in a page, as well as related metadata fields. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • associations (list of Associations.Summary) – List of tag associations. This attribute was added in vSphere API +7.0.0.0.

    • +

  • marker (str or None) – Marker is an opaque data structure that allows the caller to +request the next page of tag associations. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.tagging.associations.Marker. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.tagging.associations.Marker. +If None or empty, there are no more tag associations to request.

    • +

  • status (Associations.LastIterationStatus) – The last status for the iterator that indicates whether any more +results can be expected if the caller continues to make requests +for more data using the iterator. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(tag=None, object=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Associations.Summary describes a tag association. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • tag (str) – The identifier of a tag. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.cis.tagging.Tag. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.cis.tagging.Tag.

    • +

  • object (com.vmware.vapi.std_client.DynamicID) – The identifier of an associated object. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+list(iterate=None)
+

Returns tag associations that match the specified iteration spec. This +method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

iterate (Associations.IterationSpec or None) – The specification of a page to be retrieved. +If None, the first page will be retrieved.

+
+
Return type
+

Associations.ListResult

+
+
Returns
+

A page of the tag associations matching the iteration spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if Associations.IterationSpec.marker is not a marker +returned from an earlier invocation of this {\@term operation).

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.tagging_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.tokenservice_client module

+

The com.vmware.vcenter.tokenservice_client module provides Token classes.

+
+
+exception com.vmware.vcenter.tokenservice_client.Error(messages=None, data=None)
+

Bases: vmware.vapi.bindings.error.VapiError

+

The Error exception describes theattributes common to all standard +exceptions.

+

This exception serves two purposes:

+
    +

  1. It is the exception that clients in many programming languages can catch +to handle all standard exceptions. Typically those clients will display one +or more of the localizable messages from Error.messages to a human.

    2. +

  2. It is the exception that methods can report when they need to report +some exception, but the exception doesn’t fit into any other standard +exception, and in fact the only reasonable way for a client to react to the +exception is to display the message(s) to a human.

    3. +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked. Each subsequent message in the stack describes the “cause” +of the prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports. The +ArgumentLocations, FileLocations, and TransientIndication classes +are intended as possible values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +
+
+
+
+ +
+
+exception com.vmware.vcenter.tokenservice_client.InvalidGrant(messages=None, data=None)
+

Bases: com.vmware.vcenter.tokenservice_client.Error

+

The InvalidGrant exception indicates that provided authorization grant +(e.g., authorization code, resource owner credentials) or refresh token is +invalid, expired, revoked, does not match the redirection URI used in the +authorization request, or was issued to another client.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked. Each subsequent message in the stack describes the “cause” +of the prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports. The +ArgumentLocations, FileLocations, and TransientIndication classes +are intended as possible values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +
+
+
+
+ +
+
+exception com.vmware.vcenter.tokenservice_client.InvalidRequest(messages=None, data=None)
+

Bases: com.vmware.vcenter.tokenservice_client.Error

+

The InvalidRequest exception indicates that +TokenExchange.ExchangeSpec is missing a required parameter, +includes an unsupported parameter value (other than +TokenExchange.ExchangeSpec.grant_type)

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked. Each subsequent message in the stack describes the “cause” +of the prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports. The +ArgumentLocations, FileLocations, and TransientIndication classes +are intended as possible values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +
+
+
+
+ +
+
+exception com.vmware.vcenter.tokenservice_client.InvalidScope(messages=None, data=None)
+

Bases: com.vmware.vcenter.tokenservice_client.Error

+

The InvalidScope exception indicates requested scope is invalid, +unknown, malformed, or exceeds the scope granted by the resource owner.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Stack of one or more localizable messages for human exception +consumers.

    +

    The message at the top of the stack (first in the list) describes +the exception from the perspective of the method the client +invoked. Each subsequent message in the stack describes the “cause” +of the prior message.

    +

    • +

  • data (vmware.vapi.struct.VapiStruct or None) –

    Data to facilitate clients responding to the method reporting a +standard exception to indicating that it was unable to complete +successfully.

    +

    Methods may provide data that clients can use when responding to +exceptions. Since the data that clients need may be specific to the +context of the method reporting the exception, different methods +that report the same exception may provide different data in the +exception. The documentation for each each method will describe +what, if any, data it provides for each exception it reports. The +ArgumentLocations, FileLocations, and TransientIndication classes +are intended as possible values for this attribute. +com.vmware.vapi.std_client.DynamicID may also be useful as +a value for this attribute (although that is not its primary +purpose). Some classes may provide their own specific classes for +use as the value of this attribute when reporting exceptions from +their methods. +Some methods will not set this attribute when reporting exceptions.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.tokenservice_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.tokenservice_client.TokenExchange(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TokenExchange interface provides possibility to exchange between +different tokens types. Implementation of “OAuth 2.0 Token Exchange” +standard (https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12).

+

This interface has been deprecated in the vSphere 7.0 U2 release. Use +com.vmware.vcenter.authentication.Token instead.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+ACCESS_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:access_token'
+

Class attribute indicates OAuth 2.0 access token type.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+BEARER_TOKEN_METHOD_TYPE = 'Bearer'
+

Class attribute indicates that the security token is a bearer token.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+class ExchangeSpec(grant_type=None, resource=None, audience=None, scope=None, requested_token_type=None, subject_token=None, subject_token_type=None, actor_token=None, actor_token_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TokenExchange.ExchangeSpec class contains arguments required for +token exchange.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • grant_type (str) – The value of TokenExchange.TOKEN_EXCHANGE_GRANT indicates +that a token exchange is being performed.

    • +

  • resource (str or None) – Indicates the location of the target service or resource where the +client intends to use the requested security token. +if can be inferred from other arguments or not needed for specific +case of exchange.

    • +

  • audience (str or None) – The logical name of the target service where the client intends to +use the requested security token. This serves a purpose similar to +the TokenExchange.ExchangeSpec.resource parameter, but with +the client providing a logical name rather than a location. +if can be inferred from other arguments or not needed for specific +case of exchange.

    • +

  • scope (str or None) – A list of space-delimited, case-sensitive strings, that allow the +client to specify the desired scope of the requested security token +in the context of the service or resource where the token will be +used. +if can be inferred from other arguments or not needed for specific +case of exchange.

    • +

  • requested_token_type (str or None) – An identifier for the type of the requested security token. If the +requested type is unspecified, the issued token type is at the +discretion of the server and may be dictated by knowledge of the +requirements of the service or resource indicated by the +TokenExchange.ExchangeSpec.resource or +TokenExchange.ExchangeSpec.audience parameter. +if can be inferred from other arguments or not needed for specific +case of exchange.

    • +

  • subject_token (str) – A security token that represents the identity of the party on +behalf of whom exchange is being made. Typically, the subject of +this token will be the subject of the security token issued. Token +is base64-encoded.

    • +

  • subject_token_type (str) – An identifier, that indicates the type of the security token in the +TokenExchange.ExchangeSpec.subject_token parameter.

    • +

  • actor_token (str or None) – A security token that represents the identity of the acting party. +Typically, this will be the party that is authorized to use the +requested security token and act on behalf of the subject. +if not needed for specific case of exchange.

    • +

  • actor_token_type (str or None) – An identifier, that indicates the type of the security token in the +TokenExchange.ExchangeSpec.actor_token parameter. +if TokenExchange.ExchangeSpec.actor_token parameter is not +present.

    • +
+
+
+
+ +
+
+ID_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:id_token'
+

Class attribute indicates OIDC ID token type.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+class Info(access_token=None, issued_token_type=None, token_type=None, expires_in=None, scope=None, refresh_token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TokenExchange.Info class contains data that represents successful +token exchange response.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • access_token (str) – The security token issued by the server in response to the token +exchange request. Token is base64-encoded.

    • +

  • issued_token_type (str) – An identifier, that indicates the type of the security token in the +TokenExchange.Info.access_token parameter.

    • +

  • token_type (str) – A case-insensitive value specifying the method of using the access +token issued.

    • +

  • expires_in (long or None) – The validity lifetime, in seconds, of the token issued by the +server. +if not applicable for issued token.

    • +

  • scope (str or None) – Scope of the issued security token. +if the scope of the issued security token is identical to the scope +requested by the client.

    • +

  • refresh_token (str or None) – A refresh token can be issued in cases where the client of the +token exchange needs the ability to access a resource even when the +original credential is no longer valid. +if not needed for specific case of exchange.

    • +
+
+
+
+ +
+
+N_A_TOKEN_METHOD_TYPE = 'N_A'
+

Class attribute indicates TokenExchange.Info.token_type identifier is +not applicable in that context.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+REFRESH_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:refresh_token'
+

Class attribute indicates OAuth 2.0 refresh token type.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+SAML1_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:saml1'
+

Class attribute indicates base64-encoded SAML 1.1 token type.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+SAML2_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:saml2'
+

Class attribute indicates base64-encoded SAML 2.0 token type.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+TOKEN_EXCHANGE_GRANT = 'urn:ietf:params:oauth:grant-type:token-exchange'
+

Class attribute indicates that token exchange grant type.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+ +
+
+exchange(spec)
+

Exchanges incoming token based on the spec and current client +authorization data.

+

This method has been deprecated in the vSphere 7.0 U2 release. Use +com.vmware.vcenter.authentication.Token#issue instead.

+
+

Deprecated since version vSphere: API 7.0.2.0

+
+
+
Parameters
+

spec (TokenExchange.ExchangeSpec) – TokenExchange.ExchangeSpec class contains arguments that define +exchange process.

+
+
Return type
+

TokenExchange.Info

+
+
Returns
+

TokenExchange.Info class that contains new token.

+
+
Raise
+

InvalidGrant +provided authorization grant (e.g., authorization code, resource +owner credentials) or refresh token is invalid, expired, revoked, +does not match the redirection URI used in the authorization +request, or was issued to another client.

+
+
Raise
+

InvalidScope +If the server is unwilling or unable to issue a token for all the +target services indicated by the +TokenExchange.ExchangeSpec.resource or +TokenExchange.ExchangeSpec.audience parameters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization is not given to a caller.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.topology_client module

+

The com.vmware.vcenter.topology_client module provides classes to retrieve +all vCenter and Platform Services Controller nodes and replication status in +the topology.

+
+
+class com.vmware.vcenter.topology_client.Nodes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Nodes interface provides methods to retrieve vCenter and Platform +Services Controller nodes information in the topology. This class was added +in vSphere API 6.7.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ApplianceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Nodes.ApplianceType class defines values for valid appliance types +for the vCenter and Platform Services Controller node. See +Nodes.Info. This enumeration was added in vSphere API 6.7.2.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ApplianceType instance.

+
+
+
+
+PSC_EXTERNAL = ApplianceType(string='PSC_EXTERNAL')
+

An external Platform Services Controller. This class attribute was added in +vSphere API 6.7.2.

+
+ +
+
+VCSA_EMBEDDED = ApplianceType(string='VCSA_EMBEDDED')
+

vCenter Server Appliance with an embedded Platform Services Controller. +This class attribute was added in vSphere API 6.7.2.

+
+ +
+
+VCSA_EXTERNAL = ApplianceType(string='VCSA_EXTERNAL')
+

vCenter Server Appliance with an external Platform Services Controller. +This class attribute was added in vSphere API 6.7.2.

+
+ +
+ +
+
+class FilterSpec(types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Nodes.FilterSpec class contains attribute used to filter the +results when listing vCenter and Platform Services Controller nodes (see +Nodes.list()). This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

types (set of Nodes.ApplianceType or None) – Types of the appliance that a vCenter and Platform Services +Controller node must be to match the filter (see +Nodes.ApplianceType. This attribute was added in vSphere +API 6.7.2. +If None or empty, node of any ApplianceType match the filter.

+
+
+
+ +
+
+class Info(domain=None, type=None, replication_partners=None, client_affinity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Nodes.Info class contains vCenter or Platform Services Controller +node details. This class was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • domain (str) – Domain name of the node. This attribute was added in vSphere API +6.7.2.

    • +

  • type (Nodes.ApplianceType) – Appliance type of the node. This attribute was added in vSphere API +6.7.2.

    • +

  • replication_partners (list of str) – List of replication partners’ node identifiers. Identifiers can be +either IP address or DNS resolvable name of the partner node. This +attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.VCenter.name. +This attribute is optional and it is only relevant when the value +of type is one of Nodes.ApplianceType.VCSA_EMBEDDED or +Nodes.ApplianceType.PSC_EXTERNAL.

    • +

  • client_affinity (str) – Identifier of the affinitized Platform Services Controller node. +Identifier can be either IP address or DNS resolvable name of the +affinitized node. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.VCenter.name. +This attribute is optional and it is only relevant when the value +of type is Nodes.ApplianceType.VCSA_EXTERNAL.

    • +
+
+
+
+ +
+
+class Summary(node=None, type=None, replication_partners=None, client_affinity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Nodes.Summary class contains commonly used information of vCenter +or Platform Services Controller node. This class was added in vSphere API +6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • node (str) – Identifier for the vCenter or Platform Services Controller node. +Identifier can be either IP address or DNS resolvable name of the +node. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.VCenter.name.

    • +

  • type (Nodes.ApplianceType) – Appliance type of the node. This attribute was added in vSphere API +6.7.2.

    • +

  • replication_partners (list of str) – List of replication partners’ node identifiers. Identifiers can be +either IP address or DNS resolvable name of the partner node. This +attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.VCenter.name. +This attribute is optional and it is only relevant when the value +of type is one of Nodes.ApplianceType.VCSA_EMBEDDED or +Nodes.ApplianceType.PSC_EXTERNAL.

    • +

  • client_affinity (str) – Identifier of the affinitized Platform Services Controller node. +Identifier can be either IP address or DNS resolvable name of the +affinitized node. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.VCenter.name. +This attribute is optional and it is only relevant when the value +of type is Nodes.ApplianceType.VCSA_EXTERNAL.

    • +
+
+
+
+ +
+
+get(node)
+

Retrieve details for a given identifier of the vCenter or Platform +Services Controller node. This method was added in vSphere API 6.7.2.

+
+
Parameters
+

node (str) – Identifier of the vCenter or Platform Services Controller node. +Identifier can be either IP address or DNS resolvable name of the +node. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.VCenter.name.

+
+
Return type
+

Nodes.Info

+
+
Returns
+

vCenter or Platform Services Controller node details with +replication partners and client affinity information as applicable. +See Nodes.Info.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a node doesn’t exist for given node identifier.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns information about all vCenter and Platform Services Controller +nodes matching the Nodes.FilterSpec. This method was added in +vSphere API 6.7.2.

+
+
Parameters
+

filter (Nodes.FilterSpec or None) – Specification of matching vCenter and Platform Services Controller +nodes for which information should be returned. +If None, the behavior is equivalent to a Nodes.FilterSpec +with all attributes None which means all nodes match the filter.

+
+
Return type
+

list of Nodes.Summary

+
+
Returns
+

commonly used information for all vCenter and Platform Services +Controller nodes matching the Nodes.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Nodes.FilterSpec.types attribute contains a value +that is not supported.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.topology_client.ReplicationStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ReplicationStatus interface provides methods to retrieve +replication status information of vCenter and Platform Services Controller +nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type). +This class was added in vSphere API 6.7.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(nodes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ReplicationStatus.FilterSpec class contains attribute used to +filter the results when listing replication status for the vCenter and +Platform Services Controller nodes (see ReplicationStatus.list()) of +type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type). This class +was added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

nodes (set of str or None) – Identifier that a vCenter and Platform Services Controller node +must have to match the filter. (see +ReplicationStatus.Summary.node). This attribute was added +in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.VCenter.name. +If None or empty, all vCenter and Platform Services Controller +nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.

+
+
+
+ +
+
+class Summary(node=None, replication_partner=None, partner_available=None, status_available=None, replicating=None, change_lag=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ReplicationStatus.Summary class contains replication information of +partner vCenter or Platform Services Controller node of type +VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type). This class was +added in vSphere API 6.7.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • node (str) – Identifier for the vCenter or Platform Services Controller node. +Identifier can be either IP address or DNS resolvable name of the +node. This attribute was added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.VCenter.name.

    • +

  • replication_partner (str) – Identifier for the vCenter or Platform Services Controller +replication partner. Identifier can be either IP address or DNS +resolvable name of the replication partner. This attribute was +added in vSphere API 6.7.2. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.VCenter.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.VCenter.name.

    • +

  • partner_available (bool) – Indicates if the VMware Directory Service on partner is reachable +or not. This attribute was added in vSphere API 6.7.2.

    • +

  • status_available (bool) – Indicates if the replication status for the node with respect to +replication partner can be retrieved or not. This attribute was +added in vSphere API 6.7.2.

    • +

  • replicating (bool or None) – Indicates if node is processing replication changes from the +replication partner. This attribute was added in vSphere API 6.7.2. +This attribute will be None if the partner host or replication +status is not available, i.e, if +ReplicationStatus.Summary.partner_available or +ReplicationStatus.Summary.status_available is false.

    • +

  • change_lag (long or None) – Number of replication changes node is behind the replication +partner. This attribute was added in vSphere API 6.7.2. +This attribute will be None if the partner host or replication +status is not available, i.e, if +ReplicationStatus.Summary.partner_available or +ReplicationStatus.Summary.status_available is false.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns the replication information of vCenter and Platform Services +Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see +Nodes.Info.type) matching the +ReplicationStatus.FilterSpec. This method was added in vSphere +API 6.7.2.

+
+
Parameters
+

filter (ReplicationStatus.FilterSpec or None) – Specification of matching vCenter and Platform Services Controller +nodes for which information should be returned. +If None, the behavior is equivalent to a +ReplicationStatus.FilterSpec with all attributes None +which means all vCenter and Platform Services Controller nodes of +type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.

+
+
Return type
+

list of ReplicationStatus.Summary

+
+
Returns
+

Commonly used replication information about vCenter and Platform +Services Controller nodes matching the +ReplicationStatus.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the ReplicationStatus.FilterSpec.nodes attribute +contains a invalid value.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.topology_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure_client module

+

The com.vmware.vcenter.trusted_infrastructure_client module provides +classes that enable a Trusted Infrastructure. They are responsible for ensuring +that infrastructure nodes are running trusted software and for releasing +encryption keys only to trusted infrastructure nodes.

+
+
+class com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress(hostname=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NetworkAddress class contains an IP address or DNS resolvable name +and a port on which a connection can be established. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – The IP address or DNS resolvable name of the service. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • port (long or None) – The port of the service. This attribute was added in vSphere API +7.0.0.0. +If None, port 443 will be used.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.Principal(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Principal class contains information about the certificates which +sign the tokens used by vCenter for authentication. This class was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(certificates=None, issuer=None, principal=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Principal.Info class contains the information about the principal +and certificates used by this vCenter to retrieve tokens. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • certificates (list of X509CertChain) – The certificates used by the STS to sign tokens for this vCenter. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • issuer (str) – The service which created and signed the security token. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • principal (StsPrincipal) – The principal used by this vCenter instance to retrieve tokens. +Currently this is the vCenter solution user. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • name (str) – The user-friednly name of the vCenter. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+get()
+

Returns information about the STS used by this vCenter instance. This +method was added in vSphere API 7.0.0.0.

+
+
Return type
+

Principal.Info

+
+
Returns
+

\@{link Info} a summary containing the certificates used to sign +tokens and the solution user used to retrieve them.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadStsInfo.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal(id=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StsPrincipal class contains a IDM principal. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (StsPrincipalId) – The principal’s ID. This attribute was added in vSphere API +7.0.0.0.

    • +

  • type (StsPrincipalType) – The type of the principal (user or group). This attribute was added +in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId(name=None, domain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The StsPrincipalId class contains an IDM principal ID. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The principal’s username. This attribute was added in vSphere API +7.0.0.0.

    • +

  • domain (str) – The principal’s domain. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The StsPrincipalType enum can be either users or groups. This +enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the StsPrincipalType instance.

+
+
+
+
+STS_GROUP = StsPrincipalType(string='STS_GROUP')
+

The principal is a group. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+STS_USER = StsPrincipalType(string='STS_USER')
+

The principal is a user. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TrustAuthorityClusters class manages all the Trust Authority +Components on each Trust Authority Host in the cluster. The +TrustAuthorityClusters class transforms a ClusterComputeResource into +Trust Authority Cluster and vice versa. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(cluster=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustAuthorityClusters.FilterSpec class contains the data necessary +for identifying a TrustAuthorityClusters. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (set of str or None) – Identifies the cluster. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +cluster If {\@term.unset} return all Trust Authority Clusters.

    • +

  • state (set of TrustAuthorityClusters.State or None) – The state of the TrustAuthorityClusters. This attribute +was added in vSphere API 7.0.0.0. +state If {\@term.unset} return all Trust Authority Clusters.

    • +
+
+
+
+ +
+
+class Info(cluster=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustAuthorityClusters.Info class contains the data necessary for +retrieving the TrustAuthorityClusters info. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifies the cluster. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • state (TrustAuthorityClusters.State) – The state of the cluster. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The TrustAuthorityClusters.State class defines the states of the +TrustAuthorityClusters. This enumeration was added in vSphere API +7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+DISABLE = State(string='DISABLE')
+

The TrustAuthorityClusters is disabled. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+ENABLE = State(string='ENABLE')
+

The TrustAuthorityClusters is enabled. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Summary(cluster=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustAuthorityClusters.Summary class contains information about +TrustAuthorityClusters id and state. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifies the cluster. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • state (TrustAuthorityClusters.State) – The state of the TrustAuthorityClusters. This attribute +was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class UpdateSpec(state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustAuthorityClusters.UpdateSpec class contains the data necessary +for update of a TrustAuthorityClusters. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

state (TrustAuthorityClusters.State or None) – The state of the TrustAuthorityClusters. This attribute +was added in vSphere API 7.0.0.0. +state If {\@term.unset} no operation is performed.

+
+
+
+ +
+
+get(cluster)
+

Get the result of the last Update operation which matches the cluster +id. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

cluster (str) – Cluster id. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

TrustAuthorityClusters.Info

+
+
Returns
+

The TrustAuthorityClusters.Info instance which contains +information about the state of the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t match to any ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires System.View.

    • +
+
+
+
+ +
+
+list(spec=None)
+

Returns a list of clusters for this vCenter instance which matches the +TrustAuthorityClusters.FilterSpec. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

spec (TrustAuthorityClusters.FilterSpec or None) – Return only clusters matching the specified filters. +If {\@term.unset} return all clusters.

+
+
Return type
+

list of TrustAuthorityClusters.Summary

+
+
Returns
+

List of TrustAuthorityClusters.Summary for a +TrustAuthorityClusters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource ClusterComputeResource referenced by the +attribute TrustAuthorityClusters.FilterSpec.cluster +requires System.View.

    • +
+
+
+
+ +
+
+update_task(cluster, spec)
+

Updates the state of a cluster. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Cluster id. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (TrustAuthorityClusters.UpdateSpec) – The specification for update of a cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if spec doesn’t match to any cluster compute resource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure_client.X509CertChain(cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The X509CertChain class contains x509 certificate chain. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

cert_chain (list of str) – Certificate chain in base64 format. This attribute was added in +vSphere API 7.0.0.0.

+
+
+
+ +
+
+

com.vmware.vcenter.vcha_client module

+

The com.vmware.vcenter.vcha_client module provides classes for deploying +and monitoring a vCenter High Availability (VCHA) Cluster.

+
+
+class com.vmware.vcenter.vcha_client.CertificateInfo(ssl_thumbprint=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CertificateInfo Class contains information about the SSL +certificate for a management vCenter server. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ssl_thumbprint (str) – The SHA-256 thumbprint of the SSL certificate for a management +vCenter server. This attribute was added in vSphere API 6.7.1.

+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.Cluster(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Cluster class provides methods to deploy and undeploy a vCenter +High Availability (VCHA) cluster, failover from the active VCHA node to the +passive VCHA node, and retrieve the status of the VCHA cluster. This class +was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ActiveSpec(ha_network_type=None, ha_network=None, ha_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.ActiveSpec class contains the deploy specification for the +Active Node of the VCHA cluster. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ha_network_type (NetworkType or None) – The type of the Network object used by the HA network. +If the Cluster.ActiveSpec.ha_network attribute is set, then +the Cluster.ActiveSpec.ha_network_type field must be set. +If the Cluster.ActiveSpec.ha_network attribute is None, +then the Cluster.ActiveSpec.ha_network_type attribute is +ignored. This attribute was added in vSphere API 6.7.1. +If None and the Cluster.ActiveSpec.ha_network attribute is +unset, then the second NIC is assumed to be already configured. +If None and the Cluster.ActiveSpec.ha_network attribute is +set, then an error is reported.

    • +

  • ha_network (str or None) – The identifier of the Network object used for the HA network. +If the Cluster.ActiveSpec.ha_network attribute is set, then +the Cluster.ActiveSpec.ha_network_type attribute must be +set. +If the Cluster.ActiveSpec.ha_network attribute is None, +then the Cluster.ActiveSpec.ha_network_type attribute is +ignored. This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +If None and the Cluster.ActiveSpec.ha_network_type +attribute is unset, then the second NIC is assumed to be already +configured. +If None and the Cluster.ActiveSpec.ha_network attribute is +set, then an error is reported.

    • +

  • ha_ip (IpSpec) – IP specification for the HA network. This attribute was added in +vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class ClusterMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.ClusterMode class defines the possible modes for a VCHA +Cluster. This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ClusterMode instance.

+
+
+
+
+DISABLED = ClusterMode(string='DISABLED')
+

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.

+
+ +
+
+ENABLED = ClusterMode(string='ENABLED')
+

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.

+
+ +
+
+MAINTENANCE = ClusterMode(string='MAINTENANCE')
+

VCHA Cluster is in maintenance mode. State replication between the Active +and Passive node is enabled but automatic failover is not allowed. This +class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+class ClusterState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.ClusterState class defines the possible for a VCHA Cluster. +This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ClusterState instance.

+
+
+
+
+DEGRADED = ClusterState(string='DEGRADED')
+

A VCHA Cluster is said to be in a degraded state for either or all of the +following reasons:

+
    +

  • There is a node loss.

    • +

  • State replication between the Active and Passive node fails.

    • +
+

. This class attribute was added in vSphere API 6.7.1.

+
+ +
+
+HEALTHY = ClusterState(string='HEALTHY')
+

All three nodes in a VCHA Cluster are healthy and connected. State +replication between Active and Passive node is working and both nodes are +in sync. This class attribute was added in vSphere API 6.7.1.

+
+ +
+
+ISOLATED = ClusterState(string='ISOLATED')
+

All three nodes are isolated from each other. This class attribute was +added in vSphere API 6.7.1.

+
+ +
+ +
+
+class ConfigState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.ConfigState class defines the VCHA configuration state. +This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigState instance.

+
+
+
+
+CONFIGURED = ConfigState(string='CONFIGURED')
+

VCHA cluster is configured. This class attribute was added in vSphere API +6.7.1.

+
+ +
+
+INVALID = ConfigState(string='INVALID')
+

VCHA cluster is in an invalid/dirty state. This class attribute was added +in vSphere API 6.7.1.

+
+ +
+
+NOTCONFIGURED = ConfigState(string='NOTCONFIGURED')
+

VCHA cluster is not configured. This class attribute was added in vSphere +API 6.7.1.

+
+ +
+
+PREPARED = ConfigState(string='PREPARED')
+

vCenter server appliance has been prepared for VCHA cluster configuration. +This class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+class DeploySpec(vc_spec=None, deployment=None, active=None, passive=None, witness=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.DeploySpec class contains the deploy specification for the +three nodes of a VCHA cluster. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vc_spec (CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. +This attribute was added in vSphere API 6.7.1. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • deployment (Cluster.Type) – Contains the deployment type. This attribute was added in vSphere +API 6.7.1.

    • +

  • active (Cluster.ActiveSpec) – Contains the active node’s network configuration. This attribute +was added in vSphere API 6.7.1.

    • +

  • passive (Cluster.PassiveSpec) – Contains the passive node’s placement configuration. This attribute +was added in vSphere API 6.7.1.

    • +

  • witness (Cluster.WitnessSpec) – Contains the witness node’s placement configuration. This attribute +was added in vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class ErrorCondition(error=None, recommendation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.ErrorCondition class contains an error condition and a +recommendation to handle the error condition. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Info(config_state=None, node1=None, node2=None, witness=None, mode=None, health_state=None, health_exception=None, health_warnings=None, manual_failover_allowed=None, auto_failover_allowed=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.Info class contains the configuration and health +information of the three nodes in a VCHA Cluster. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config_state (Cluster.ConfigState or None) – Configuration state of the VCHA cluster. +The active node’s management vCenter server credentials are not +required to populate this attribute. This attribute was added in +vSphere API 6.7.1. +If None, then the information is unavailable.

    • +

  • node1 (Cluster.NodeInfo or None) – Node configuration information for the VCHA cluster. This attribute +was added in vSphere API 6.7.1. +If None, then the information is unavailable.

    • +

  • node2 (Cluster.NodeInfo or None) – Node configuration information for the VCHA cluster. This attribute +was added in vSphere API 6.7.1. +If None, then the information is unavailable or the node is not +cloned yet.

    • +

  • witness (Cluster.WitnessInfo or None) – Node configuration information for the VCHA cluster. This attribute +was added in vSphere API 6.7.1. +If None, then the information is unavailable or the node is not +cloned yet.

    • +

  • mode (Cluster.ClusterMode or None) – Operational mode of the VCHA Cluster. This attribute was added in +vSphere API 6.7.1. +If None, then the information is unavailable or the node is not +cloned yet.

    • +

  • health_state (Cluster.ClusterState or None) – Last known state of the VCHA Cluster. This attribute was added in +vSphere API 6.7.1. +If None, then the information is unavailable or the node is not +cloned yet.

    • +

  • health_exception (list of com.vmware.vapi.std_client.LocalizableMessage or None) – Health warning messages if the health information is unavailable. +This attribute was added in vSphere API 6.7.1. +If None, then the cluster is in a healthy state.

    • +

  • health_warnings (list of Cluster.ErrorCondition or None) – A collection of messages describing the reason for a non-healthy +Cluster. This attribute was added in vSphere API 6.7.1. +If None, then the cluster is in a healthy state.

    • +

  • manual_failover_allowed (bool or None) – Specifies if manual failover is allowed. This attribute was added +in vSphere API 6.7.1. +If None, then the cluster state healthy and manual failover +allowance in accordance with the cluster mode.

    • +

  • auto_failover_allowed (bool or None) – Specifies if automatic failover is allowed. This attribute was +added in vSphere API 6.7.1. +If None, then the cluster state healthy and automatic failover +allowance in accordance with the cluster mode.

    • +
+
+
+
+ +
+
+class IpFamily(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.IpFamily class defines the IP address family. This +enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpFamily instance.

+
+
+
+
+IPV4 = IpFamily(string='IPV4')
+

IPV4 address family. This class attribute was added in vSphere API 6.7.1.

+
+ +
+
+IPV6 = IpFamily(string='IPV6')
+

IPV6 address family. This class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+class IpInfo(ip_family=None, ipv4=None, ipv6=None, gateway_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.IpInfo class contains attributes related to an ip. This +class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ip_family (Cluster.IpFamily) – Family of the ip. This attribute was added in vSphere API 6.7.1.

    • +

  • ipv4 (Cluster.Ipv4Info) – If the type of the ip family is IPV4, then this will point to IPv4 +address specification. This attribute was added in vSphere API +6.7.1. +This attribute is optional and it is only relevant when the value +of ipFamily is Cluster.IpFamily.IPV4.

    • +

  • ipv6 (Cluster.Ipv6Info) – If the type of the ip family is IPV6, then this will point to IPv6 +address specification. This attribute was added in vSphere API +6.7.1. +This attribute is optional and it is only relevant when the value +of ipFamily is Cluster.IpFamily.IPV6.

    • +

  • gateway_ip (str or None) – Gateway IP address. This attribute was added in vSphere API 6.7.1. +If None, no gateway is specified.

    • +
+
+
+
+ +
+
+class Ipv4Info(address=None, subnet_mask=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.Ipv4Info class contains attributes to describe IPV4 +information of the configured network interface. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IP address of the configured network interface. This attribute was +added in vSphere API 6.7.1.

    • +

  • subnet_mask (str) – The subnet mask of the interface. This attribute was added in +vSphere API 6.7.1.

    • +

  • prefix (long or None) – The CIDR prefix of the interface. This attribute was added in +vSphere API 6.7.1. +If None , then the subnet mask is invalid.

    • +
+
+
+
+ +
+
+class Ipv6Info(address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.Ipv6Info class contains attributes to describe IPV6 +information of the configured network interface. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IP address of the configured network interface. This attribute was +added in vSphere API 6.7.1.

    • +

  • prefix (long) – The CIDR prefix of the interface. This attribute was added in +vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class NodeInfo(failover_ip=None, ha_ip=None, runtime=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.NodeInfo class defines the configuration information for +the active and passive nodes in the cluster. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • failover_ip (Cluster.IpInfo or None) – Failover IP address that this node will assume after the failover +to serve client requests. Each failover node can have a different +failover IP address. +The active node’s management vCenter server credentials are not +required to populate Cluster.NodeInfo.failover_ip. This +attribute was added in vSphere API 6.7.1. +If None, then it will assume the public IP address of the Active +vCenter Server.

    • +

  • ha_ip (Cluster.IpInfo) – VCHA Cluster network configuration of the node. All cluster +communication (state replication, heartbeat, cluster messages) +happens over this network. +The active node’s management vCenter server credentials are not +required to populate this Cluster.NodeInfo.ha_ip. This +attribute was added in vSphere API 6.7.1.

    • +

  • runtime (Cluster.NodeRuntimeInfo or None) – Runtime information for the node in the VCHA Cluster. +The active node’s management vCenter server credentials are +required to populate some attributes of +Cluster.NodeInfo.runtime. This attribute was added in +vSphere API 6.7.1. +If None, then the information is unavailable or the specified +Active vCenter server management credentials are invalid or the +node is not cloned yet.

    • +
+
+
+
+ +
+
+class NodeRole(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.NodeRole class defines the role node can be in a VCHA +Cluster. This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NodeRole instance.

+
+
+
+
+ACTIVE = NodeRole(string='ACTIVE')
+

Node is having a role of Active. In this role, node runs a vCenter Server +that serves client requests. This class attribute was added in vSphere API +6.7.1.

+
+ +
+
+PASSIVE = NodeRole(string='PASSIVE')
+

Node is having a role of Passive. In this role node, runs as a standby for +the Active vCenter Server and receives state updates. This node takes over +the role of Active vCenter Server upon failover. This class attribute was +added in vSphere API 6.7.1.

+
+ +
+
+WITNESS = NodeRole(string='WITNESS')
+

Node is having a role of Witness. In this role, node acts as a quorum node +for avoiding the classic split-brain problem. This class attribute was +added in vSphere API 6.7.1.

+
+ +
+ +
+
+class NodeRuntimeInfo(state=None, role=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.NodeRuntimeInfo class describes a node’s runtime +information in a VCHA Cluster. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (Cluster.NodeState or None) – Last known state of the node. +The active node’s management vCenter server credentials are not +required to populate Cluster.NodeRuntimeInfo.state. This +attribute was added in vSphere API 6.7.1. +If None, then information is unavailable or the passive and witness +nodes are not cloned yet.

    • +

  • role (Cluster.NodeRole or None) – Last known role of the node. +The active node’s management vCenter server credentials are not +required to populate Cluster.NodeRuntimeInfo.role. This +attribute was added in vSphere API 6.7.1. +If None, then information is unavailable or the passive and witness +nodes are not cloned yet.

    • +

  • placement (PlacementInfo or None) – Placement information of the node. +The active node’s management vCenter server credentials are +required to populate most attributes of +Cluster.NodeRuntimeInfo.placement. This attribute was added +in vSphere API 6.7.1. +If None, then the information is unavailable or the specified +Active vCenter server management credentials are invalid or the +node is not cloned yet or the VCHA cluster was deployed in a manual +fashion.

    • +
+
+
+
+ +
+
+class NodeState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.NodeState class defines possible state a node can be in a +VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NodeState instance.

+
+
+
+
+DOWN = NodeState(string='DOWN')
+

Node is down and has left the VCHA Cluster. This class attribute was added +in vSphere API 6.7.1.

+
+ +
+
+UP = NodeState(string='UP')
+

Node is up and has joined the VCHA Cluster. This class attribute was added +in vSphere API 6.7.1.

+
+ +
+ +
+
+class NodeVmInfo(vm=None, bios_uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.NodeVmInfo class contains information to describe the +Virtual Machine of a node of a VCHA cluster. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm (str) – The identifier of the virtual machine of the VCHA node. This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +VirtualMachine:VCenter. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: VirtualMachine:VCenter.

    • +

  • bios_uuid (str) – BIOS UUID for the node. This attribute was added in vSphere API +6.7.1.

    • +
+
+
+
+ +
+
+class PassiveSpec(placement=None, ha_ip=None, failover_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.PassiveSpec class contains the deploy specification for the +Passive Node of the VCHA cluster. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • placement (PlacementSpec or None) – Contains the placement configuration of the node. This attribute +was added in vSphere API 6.7.1. +If None, then the it is assumed that the clone will be done +manually by the customer. In this case, the placement configuration +for the witness node should also be omitted. Only the network +configuration will be setup. Once the passive and witness nodes are +cloned from the active node, the VCHA high availability is turned +on.

    • +

  • ha_ip (IpSpec) – IP specification for the HA network. This attribute was added in +vSphere API 6.7.1.

    • +

  • failover_ip (IpSpec or None) – IP specification for the management network. This attribute was +added in vSphere API 6.7.1. +If None, then it will assume the public IP address of the Active +vCenter Server.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cluster.Type class defines the possible deployment types for a VCHA +Cluster. This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+AUTO = Type(string='AUTO')
+

Passive and witness nodes are cloned automatically. This class attribute +was added in vSphere API 6.7.1.

+
+ +
+
+MANUAL = Type(string='MANUAL')
+

Passive and witness nodes are not cloned automatically. After deployment, +the customer should clone the passive and witness virtual machines. This +class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+class UndeploySpec(vc_spec=None, force_delete=None, vms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.UndeploySpec class contains the undeploy specification for +a VCHA cluster. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vc_spec (CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. +This attribute was added in vSphere API 6.7.1. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • force_delete (bool or None) –

    Flag controlling in what circumstances the virtual machines will be +deleted. For this flag to take effect, the VCHA cluster should have +been successfully configured using automatic deployment.

    +
      +

    • If true, the Cluster.UndeploySpec.vms attribute will be +ignored, the VCHA cluster specific information is removed, and the +passive and witness virtual machines will be deleted.

      • +

    • If false, the Cluster.UndeploySpec.vms attribute contains +the information identifying the passive and witness virtual +machines.

      • +

    • If the Cluster.UndeploySpec.vms attribute is set, then it +will be validated prior to deleting the passive and witness virtual +machines and VCHA cluster specific information is removed.

      • +

    • If the Cluster.UndeploySpec.vms attribute is None, then +the passive and witness virtual machines will not be deleted. The +customer should delete them in order to cleanup completely. VCHA +cluster specific information is removed.

      • +
    +

    . This attribute was added in vSphere API 6.7.1. +If None, the Cluster.UndeploySpec.vms attribute contains +the information identifying the passive and witness virtual +machines.

    +
      +

    • If the Cluster.UndeploySpec.vms attribute is set, then it +will be validated prior to deleting the passive and witness virtual +machines. VCHA cluster specific information is removed.

      • +

    • If the Cluster.UndeploySpec.vms attribute is None, then +the passive and witness virtual machines will not be deleted. The +customer should delete them in order to cleanup completely. VCHA +cluster specific information is removed.

      • +
    +

    • +

  • vms (Cluster.VmInfo or None) –

    Contains virtual machine information for the passive and witness +virtual machines. For this flag to take effect, the VCHA cluster +should have been successfully configured using automatic +deployment.

    +

    If set, the Cluster.UndeploySpec.force_delete attribute +controls whether this information is validated.

    +
      +

    • If the Cluster.UndeploySpec.force_delete attribute is +true, then this information is ignored, VCHA cluster specific +information is removed and the passive and witness virtual machines +will be deleted.

      • +

    • If the Cluster.UndeploySpec.force_delete attribute is +None or false, then this information is validated prior to deleting +the passive and witness virtual machines. VCHA cluster specific +information is removed.

      • +
    +

    . This attribute was added in vSphere API 6.7.1. +If None, the Cluster.UndeploySpec.force_delete attribute +controls the deletion of the passive and witness virtual machines.

    +
      +

    • If the Cluster.UndeploySpec.force_delete attribute is +true, then the passive and witness virtual machines will be +deleted. VCHA cluster specific information is removed.

      • +

    • If the Cluster.UndeploySpec.force_delete attribute is +None or false, then the passive and witness virtual machines will +not be deleted. The customer should delete them in order to cleanup +completely. VCHA cluster specific information is removed.

      • +
    +

    • +
+
+
+
+ +
+
+class VmInfo(passive=None, witness=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.VmInfo class contains information to describe the Virtual +Machines of passive and witness nodes of a VCHA cluster. This class was +added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • passive (Cluster.NodeVmInfo) – The virtual machine information of the passive node. This attribute +was added in vSphere API 6.7.1.

    • +

  • witness (Cluster.NodeVmInfo) – The virtual machine information of the witness node. This attribute +was added in vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class WitnessInfo(ha_ip=None, runtime=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.WitnessInfo class defines the configuration and runtime +information for the witness node in the cluster. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ha_ip (Cluster.IpInfo) – VCHA Cluster network configuration of the node. All cluster +communication (state replication, heartbeat, cluster messages) +happens over this network. +The active node’s management vCenter server credentials are not +required to populate Cluster.WitnessInfo.ha_ip. This +attribute was added in vSphere API 6.7.1.

    • +

  • runtime (Cluster.NodeRuntimeInfo or None) – Runtime information for the node in the VCHA Cluster. +The active node’s management vCenter server credentials are +required to populate some attributes of +Cluster.WitnessInfo.runtime. This attribute was added in +vSphere API 6.7.1. +If None, then the information is unavailable or the node is not +cloned yet.

    • +
+
+
+
+ +
+
+class WitnessSpec(placement=None, ha_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cluster.WitnessSpec class contains the deploy specification for the +Witness Node of the VCHA cluster. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • placement (PlacementSpec or None) – Contains the placement configuration of the node. This attribute +was added in vSphere API 6.7.1. +If None, then it is assumed that the clone will be done manually by +the customer. In this case, the placement configuration for the +witness node should also be omitted. Only the network configuration +will be setup. Once the passive and witness nodes are cloned from +the active node, the VCHA high availability is turned on.

    • +

  • ha_ip (IpSpec) – IP specification for the HA network. This attribute was added in +vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+deploy_task(spec)
+

Prepares, clones, and configures a VCHA cluster. This method was added +in vSphere API 6.7.1.

+
+
Parameters
+

spec (Cluster.DeploySpec) – Contains the deploy specification for all three nodes of a VCHA +cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authenticating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+failover_task(planned)
+

Initiates failover from the active vCenter node to the passive node.

+

For forced failover, Active node immediately initiates a failover. This +may result into a data loss after failover.

+

For planned failover, Active node flushes all the state to the Passive +node, waits for the flush to complete before causing a failover. After +the failover, Passive node starts without any data loss.

+

A failover is allowed only in the following cases:

+
    +

  1. Cluster’s mode is enabled and all cluster members are present.

    2. +

  2. Cluster’s mode is maintenance and all cluster members are present.

    3. +
+

. This method was added in vSphere API 6.7.1.

+
+
Parameters
+

planned (bool) – If false, a failover is initiated immediately and may result in +data loss. +If true, a failover is initated after the Active node flushes its +state to Passive and there is no data loss.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+get(vc_spec=None, partial=None)
+

Retrieves the status of a VCHA cluster. This method was added in +vSphere API 6.7.1.

+
+
Parameters
+
    +

  • vc_spec (CredentialsSpec or None) – Contains active node’s management vCenter server credentials. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • partial (bool or None) – If true, then return only the information that does not require +connecting to the Active vCenter Server. +If false or unset, then return all the information. +If None, then return all the information.

    • +
+
+
Return type
+

Cluster.Info

+
+
Returns
+

Info structure containing the VCHA configuration and health +information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authenticating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation.

+
    +

  • If partial is false or unset, then the operation execution +requires the Global.VCServer privilege.

    • +

  • If partial is true, then the operation execution requires the +System.Read privilege.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+undeploy_task(spec)
+

Destroys the VCHA cluster and removes all VCHA specific information +from the VCVA appliance. Optionally, the passive and witness node +virtual machines will be deleted only if VCHA was deployed using +automatic deployment. The active node in the cluster continues to run +as a standalone VCVA appliance after the destroy operation has been +performed.

+

If the VCHA cluster is in a transition state and not configured, then +the VCHA cluster specific information is removed.. This method was +added in vSphere API 6.7.1.

+
+
Parameters
+

spec (Cluster.UndeploySpec) – Contains the undeploy specification for a VCHA cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authenticating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the passive virtual machine is not managed by the specified +vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the witness virtual machine is not managed by the specified +vCenter server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vcha_client.ConnectionSpec(hostname=None, port=None, ssl_thumbprint=None, username=None, password=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConnectionSpec class contains information required to connect to a +vCenter server. The connection to the vCenter server always uses the HTTPS +protocol. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – IP Address or DNS of the vCenter. This attribute was added in +vSphere API 6.7.1.

    • +

  • port (long or None) – Port number. This attribute was added in vSphere API 6.7.1. +If None, port 443 will be used.

    • +

  • ssl_thumbprint (str or None) – SHA1 hash of the server SSL certificate. This attribute was added +in vSphere API 6.7.1. +If None, empty ssl thumbprint is assumed.

    • +

  • username (str or None) – Username to access the server. This attribute was added in vSphere +API 6.7.1. +This attribute is currently required. If None, an error is +returned. In the future, if this attribute is None, the system will +attempt to identify the user. If a user cannot be identified, then +the requested operation will fail.

    • +

  • password (str or None) – Password for the specified user. This attribute was added in +vSphere API 6.7.1. +This attribute is currently required. If None, an empty password is +assumed. In the future, if this attribute is None, the system will +attempt to authenticate the user. If a user cannot be identified, +then the requested operation will fail.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.CredentialsSpec(active_location=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CredentialsSpec class contains information to connect to the +vCenter server managing the VCHA nodes. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

active_location (ConnectionSpec) – Connection information for the management vCenter Server of the +Active Node in a VCHA Cluster. This attribute was added in vSphere +API 6.7.1.

+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.DiskInfo(datastore=None, datastore_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DiskInfo class contains information to describe the storage +configuration of a vCenter virtual machine. This class was added in vSphere +API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str) – The identifier of the datastore to put all the virtual disks on. +This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore:VCenter. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: Datastore:VCenter.

    • +

  • datastore_name (str) – The name of the datastore. This attribute was added in vSphere API +6.7.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.DiskSpec(datastore=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DiskSpec class contains information to describe the storage +configuration of a vCenter virtual machine. This class was added in vSphere +API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

datastore (str or None) – The identifier of the datastore to put all the virtual disks on. +This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore:VCenter. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: Datastore:VCenter. +This field needs to be set. If None, then see +vim.vm.RelocateSpec.datastore.

+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.IpFamily(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The IpFamily class defines the Ip address family. This enumeration was +added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpFamily instance.

+
+
+
+
+IPV4 = IpFamily(string='IPV4')
+

IPV4 address family. This class attribute was added in vSphere API 6.7.1.

+
+ +
+
+IPV6 = IpFamily(string='IPV6')
+

IPv6 address family. This class attribute was added in vSphere API 6.7.1.

+
+ +
+ +
+
+class com.vmware.vcenter.vcha_client.IpSpec(ip_family=None, ipv4=None, ipv6=None, default_gateway=None, dns_servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IpSpec class contains IP information used to configure a network +interface. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ip_family (IpFamily) – Family of the IP address to configure the interface. This attribute +was added in vSphere API 6.7.1.

    • +

  • ipv4 (Ipv4Spec) – If the family of the ip is IPV4, then this will point to IPv4 +address specification. This attribute was added in vSphere API +6.7.1. +This attribute is optional and it is only relevant when the value +of ipFamily is IpFamily.IPV4.

    • +

  • ipv6 (Ipv6Spec) – If the family of the ip is IPV6, then this will point to IPv6 +address specification. This attribute was added in vSphere API +6.7.1. +This attribute is optional and it is only relevant when the value +of ipFamily is IpFamily.IPV6.

    • +

  • default_gateway (str or None) – The IP address of the Gateway for this interface. This attribute +was added in vSphere API 6.7.1. +If None, gateway will not be used for the network interface.

    • +

  • dns_servers (list of str or None) – The list of IP addresses of the DNS servers for this interface. +This list is a comma separated list. This attribute was added in +vSphere API 6.7.1. +If None, DNS servers will not be used for the network interface.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.Ipv4Spec(address=None, subnet_mask=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv4Spec class contains IPV4 information used to configure a +network interface. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IPV4 address to be used to configure the interface. This attribute +was added in vSphere API 6.7.1.

    • +

  • subnet_mask (str or None) – The subnet mask for the interface. This attribute was added in +vSphere API 6.7.1. +If None and the prefix attribute is None, then an error will be +reported. +If None and the prefix attribute is set, then the prefix +attribute will be used to create a subnet mask whose first prefix +bits are 1 and the remaining bits 0. +If both the subnetMask attribute and the prefix attribute +are set and they do not represent the same value, then an error +will be reported.

    • +

  • prefix (long or None) – The CIDR prefix for the interface. This attribute was added in +vSphere API 6.7.1. +If None and the subnetMask attribute is None, this an error +will be reported. +If None and the subnetMask attribute is set, then the +subnetMask attribute will be used. +If both the subnetMask attribute and the prefix attribute +are set and they do not represent the same value, then an error +will be reported.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.Ipv6Spec(address=None, prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ipv6Spec class contains IPV6 information used to configure a +network interface. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IPv6 address to be used to configure the interface. This attribute +was added in vSphere API 6.7.1.

    • +

  • prefix (long) – The CIDR prefix for the interface. This attribute was added in +vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.NetworkType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The NetworkType class defines the type of a vCenter Server network. +This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkType instance.

+
+
+
+
+DISTRIBUTED_PORTGROUP = NetworkType(string='DISTRIBUTED_PORTGROUP')
+

Distributed virtual switch. This class attribute was added in vSphere API +6.7.1.

+
+ +
+
+STANDARD_PORTGROUP = NetworkType(string='STANDARD_PORTGROUP')
+

vSphere standard portgroup network. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+ +
+
+class com.vmware.vcenter.vcha_client.Operations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Operations class provides methods to figure out the currently +active operations and currently disabled operations in a vCenter High +Availability (VCHA) cluster. This class was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+CLUSTER_DEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.deploy'
+

Identifier of the cluster deploy operation. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+CLUSTER_FAILOVER_OP = 'com.vmware.vcenter.vcha.cluster.failover'
+

Identifier of the cluster failover operation. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+CLUSTER_GET_OP = 'com.vmware.vcenter.vcha.cluster.get'
+

Identifier of the cluster get operation. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+CLUSTER_UNDEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.undeploy'
+

Identifier of the cluster undeploy operation. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+class Info(disabled=None, active=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Operations.Info class contains information about which the VCHA +operations cannot be invoked in the current state of the system and the +list of currently active VCHA operations. This class was added in vSphere +API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+MODE_GET_OP = 'com.vmware.vcenter.vcha.cluster.mode.get'
+

Identifier of the get mode operation. This class attribute was added in vSphere +API 6.7.1.

+
+ +
+
+MODE_SET_OP = 'com.vmware.vcenter.vcha.cluster.mode.set'
+

Identifier of the set mode operation. This class attribute was added in vSphere +API 6.7.1.

+
+ +
+
+PASSIVE_REDEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.passive.redeploy'
+

Identifier of the passive redeploy operation. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+WITNESS_REDEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.witness.redeploy'
+

Identifier of the witness redeploy operation. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+get()
+

Retrieves the current active and disabled operations of a VCHA cluster. +This method was added in vSphere API 6.7.1.

+
+
Return type
+

Operations.Info

+
+
Returns
+

Info structure containing the current running and disabled +operations of a VCHA cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vcha_client.PlacementInfo(management_vcenter_name=None, management_vcenter_server_guid=None, vm_name=None, datacenter=None, datacenter_name=None, host=None, host_name=None, cluster=None, cluster_name=None, ha_network=None, ha_network_name=None, ha_network_type=None, management_network=None, management_network_name=None, management_network_type=None, storage=None, bios_uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PlacementInfo class contains information to describe the inventory +placement of a single node of a VCHA cluster. +The active node’s management vCenter server credentials are required to +populate all attributes except biosUuid. This class was added in vSphere +API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • management_vcenter_name (str) – The hostname of the vCenter server that is managing the VCHA node. +This attribute was added in vSphere API 6.7.1.

    • +

  • management_vcenter_server_guid (str) – The unique identifier of the vCenter server that is managing the +VCHA node. This attribute was added in vSphere API 7.0.0.1. +This attribute is optional because it was added in a newer version +than its parent node.

    • +

  • vm_name (str) – The virtual machine name of the VCHA node. This attribute was added +in vSphere API 6.7.1.

    • +

  • datacenter (str) – The identifier of the datacenter of the VCHA node. This attribute +was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datacenter:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: Datacenter:VCenter.

    • +

  • datacenter_name (str) – The name of the datacenter of the VCHA node. This attribute was +added in vSphere API 6.7.1.

    • +

  • host (str) – The identifier of the host of the VCHA node. This attribute was +added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: HostSystem:VCenter.

    • +

  • host_name (str) – The name of the host of the VCHA node. This attribute was added in +vSphere API 6.7.1.

    • +

  • cluster (str or None) – The identifier of the cluster of which host is member. This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource:VCenter. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: ClusterComputeResource:VCenter. +If None, host is a standalone host.

    • +

  • cluster_name (str or None) – The name of the cluster of which host is member. This attribute +was added in vSphere API 6.7.1. +If None, host is a standalone host.

    • +

  • ha_network (str or None) – The identifier of the Network object used for the HA network. This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +If None, the information is currently unavailable or the haNetwork +is not configured.

    • +

  • ha_network_name (str or None) – The name of the Network object used for the HA network. This +attribute was added in vSphere API 6.7.1. +If None, the information is currently unavailable or the haNetwork +is not configured.

    • +

  • ha_network_type (NetworkType or None) – The type of the Network object used for the HA network. This +attribute was added in vSphere API 6.7.1. +If None, the information is currently unavailable or the haNetwork +is not configured.

    • +

  • management_network (str) – The identifier of the Network object used for the Management +network. This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter.

    • +

  • management_network_name (str) – The name of the Network object used for the Management network. +This attribute was added in vSphere API 6.7.1.

    • +

  • management_network_type (NetworkType) – The type of the Network object used for the Management network. +This attribute was added in vSphere API 6.7.1.

    • +

  • storage (DiskInfo) – The storage information of the VCHA node. This attribute was added +in vSphere API 6.7.1.

    • +

  • bios_uuid (str or None) – BIOS UUID for the node. This attribute was added in vSphere API +6.7.1. +If None, the information is currently unavailable.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.PlacementSpec(name=None, folder=None, host=None, resource_pool=None, ha_network_type=None, ha_network=None, management_network_type=None, management_network=None, storage=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PlacementSpec class contains information to describe the inventory +placement of a single node of a VCHA cluster. This class was added in +vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the VCHA node to be used for the virtual machine name. +This attribute was added in vSphere API 6.7.1.

    • +

  • folder (str) – The identifier of the folder to deploy the VCHA node to. This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Folder:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Folder:VCenter.

    • +

  • host (str or None) – The identifier of the host to deploy the VCHA node to. This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: HostSystem:VCenter. +If None, see vim.vm.RelocateSpec.host.

    • +

  • resource_pool (str or None) – The identifier of the resource pool to deploy the VCHA node to. +This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool:VCenter. When methods return a value of this class +as a return value, the attribute will be an identifier for the +resource type: ResourcePool:VCenter. +If None, then the active node’s resource pool will be used.

    • +

  • ha_network_type (NetworkType or None) – The type of the Network object used by the HA network. +If the PlacementSpec.ha_network attribute is set, then the +PlacementSpec.ha_network_type field must be set. +If the PlacementSpec.ha_network attribute is None, then the +PlacementSpec.ha_network_type attribute is ignored. This +attribute was added in vSphere API 6.7.1. +If None and the PlacementSpec.ha_network attribute is +unset, then the same network present on the Active node virtual +machine is used to deploy the virtual machine with an assumption +that the network is present on the destination. +If None and the PlacementSpec.ha_network attribute is set, +then an error is reported.

    • +

  • ha_network (str or None) – The identifier of the Network object used for the HA network. +If the PlacementSpec.ha_network attribute is set, then the +{#link #haNetworkType} attribute must be set. +If the PlacementSpec.ha_network attribute is None, then the +PlacementSpec.ha_network_type attribute is ignored. This +attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +If None and the PlacementSpec.ha_network_type attribute is +unset, then the same network present on the Active node virtual +machine is used to deploy the virtual machine with an assumption +that the network is present on the destination.

    • +

  • management_network_type (NetworkType or None) – The type of the Network object used by the Management network. +If the PlacementSpec.management_network attribute is set, +then the {#link #managementNetworkType} field must be set. +If the PlacementSpec.management_network attribute is None, +then the PlacementSpec.management_network_type attribute is +ignored. This attribute was added in vSphere API 6.7.1. +If None and the PlacementSpec.management_network attribute +is unset, then the same network present on the Active node virtual +machine is used to deploy the virtual machine with an assumption +that the network is present on the destination. +If None and the PlacementSpec.management_network attribute +is set, then an error is reported.

    • +

  • management_network (str or None) – The identifier of the Network object used for the Management +network. If the PlacementSpec.management_network attribute +is set, then the PlacementSpec.management_network_type +attribute must be set. +If the PlacementSpec.management_network attribute is None, +then the PlacementSpec.management_network_type attribute is +ignored. This attribute was added in vSphere API 6.7.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Network:VCenter. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Network:VCenter. +If None and the PlacementSpec.management_network_type +attribute is unset, then the same network present on the Active +node virtual machine is used to deploy the virtual machine with an +assumption that the network is present on the destination.

    • +

  • storage (DiskSpec or None) – The storage specification to deploy the VCHA node to. This +attribute was added in vSphere API 6.7.1. +If None, see vim.vm.RelocateSpec.datastore.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vcha_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm_client module

+

The com.vmware.vcenter.vm_client module provides classes for managing +virtual machines.

+
+
+class com.vmware.vcenter.vm_client.DataSets(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DataSets class provides methods for sharing information between a +virtual machine and its guest operating system.

+

See the VMware Guest SDK Programming Guide for details on using DataSets +from within a virtual machine.

+

Information is grouped into data sets, each of which contains key-value +entries comprising the data. It’s expected that each application using the +service will have at least one unique data set in which to store its data +to avoid conflict with other applications. Each data set has attributes +defining its access control and interoperability configuration.

+

It’s not recommended that sensitive data (for example, passwords or private +keys) be stored in plain-text. The data will be visible to other +applications, running both on the management network and within the guest. +The data can also be exposed by backups or templates.

+

Data set support requires the virtual machine be at virtual hardware +version Hardware.Version.VMX_20 or later.

+

Data sets should only be modified by the application that creates them. +Otherwise the application may stop working.. This class was added in +vSphere API 8.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Access(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Possible Entry access modes. This enumeration was added in vSphere API +8.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Access instance.

+
+
+
+
+NONE = Access(string='NONE')
+

No access is allowed for data set Entries. This class attribute was added +in vSphere API 8.0.0.0.

+
+ +
+
+READ_ONLY = Access(string='READ_ONLY')
+

Only read access is allowed for data set Entries. This class attribute was +added in vSphere API 8.0.0.0.

+
+ +
+
+READ_WRITE = Access(string='READ_WRITE')
+

Full read, write and delete access is allowed on data set Entries. This +class attribute was added in vSphere API 8.0.0.0.

+
+ +
+ +
+
+class CreateSpec(name=None, description=None, host=None, guest=None, omit_from_snapshot_and_clone=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataSets.CreateSpec class describes a data set to be created. This +class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the data set. It is recommended that this value take +the form “com.company.project” to avoid conflict with other +uses.. This attribute was added in vSphere API 8.0.0.0.

    • +

  • description (str) – A description of how the data set is used by its creator. This +field can contain up to 1024 bytes. This attribute was added in +vSphere API 8.0.0.0.

    • +

  • host (DataSets.Access) –

    Host access control.

    +

    Controls access to the data set by the +com.vmware.vcenter.vm.data_sets_client.Entries methods.. +This attribute was added in vSphere API 8.0.0.0.

    +

    • +

  • guest (DataSets.Access) –

    Guest access control.

    +

    Controls access to the data set from the in-guest APIs.. This +attribute was added in vSphere API 8.0.0.0.

    +

    • +

  • omit_from_snapshot_and_clone (bool or None) – If set, the data set is considered a property of the +virtual machine, and is not included in a snapshot operation or +when the virtual machine is cloned. When a virtual machine is +reverted to a snapshot, any data set with {\@link +#omitFromSnapshotAndClone) set will be destroyed. Any data +set with DataSets.CreateSpec.omit_from_snapshot_and_clone +None will be restored to the state when the snapshot was created. +This attribute was added in vSphere API 8.0.0.0. +If None, the data set is not copied when a virtual machine is +cloned or a snapshot is taken.

    • +
+
+
+
+ +
+
+class Info(name=None, description=None, host=None, guest=None, used=None, omit_from_snapshot_and_clone=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataSets.Info class describes a data set. This class was added in +vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The name of the data set. This attribute was added in vSphere API +8.0.0.0.

    • +

  • description (str) – A description of how the data set is used by its creator. This +attribute was added in vSphere API 8.0.0.0.

    • +

  • host (DataSets.Access) –

    Host access control.

    +

    Controls access to the data set by the +com.vmware.vcenter.vm.data_sets_client.Entries methods.. +This attribute was added in vSphere API 8.0.0.0.

    +

    • +

  • guest (DataSets.Access) –

    Guest access control.

    +

    Controls access to the data set from in-guest APIs.. This attribute +was added in vSphere API 8.0.0.0.

    +

    • +

  • used (long) – The total size in bytes of the Entry data in use by this data set. +This attribute was added in vSphere API 8.0.0.0.

    • +

  • omit_from_snapshot_and_clone (bool) – If set, the data set is considered a property of the +virtual machine, and is not included in a snapshot operation or +when the virtual machine is cloned. When a virtual machine is +reverted to a snapshot, any data set with {\@link +#omitFromSnapshotAndClone) set will be destroyed. Any data +set with DataSets.Info.omit_from_snapshot_and_clone None +will be restored to the state when the snapshot was created. This +attribute was added in vSphere API 8.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(data_set=None, name=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Basic data set information. This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • data_set (str) – The identifier of the data set. This attribute was added in vSphere +API 8.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.vm.DataSet.

    • +

  • name (str) – The name of the data set. This attribute was added in vSphere API +8.0.0.0.

    • +

  • description (str) – The description of the data set. This attribute was added in +vSphere API 8.0.0.0.

    • +
+
+
+
+ +
+
+class UpdateSpec(description=None, host=None, guest=None, omit_from_snapshot_and_clone=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DataSets.UpdateSpec class describes attibutes of a data set that +can be modified. This class was added in vSphere API 8.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str or None) – A description of how the data set is used by its creator. This +field can contain up to 1024 bytes. This attribute was added in +vSphere API 8.0.0.0. +If set, the value is changed.

    • +

  • host (DataSets.Access or None) – The access control from the host. This attribute was added in +vSphere API 8.0.0.0. +If set, the value is changed.

    • +

  • guest (DataSets.Access or None) – The access control from the guest. This attribute was added in +vSphere API 8.0.0.0. +If set, the value is changed.

    • +

  • omit_from_snapshot_and_clone (bool or None) – If set, the data set is considered a property of the +virtual machine, and is not included in a snapshot operation or +when the virtual machine is cloned. When a virtual machine is +reverted to a snapshot, any data set with {\@link +#omitFromSnapshotAndClone) set will be destroyed. Any data +set with DataSets.UpdateSpec.omit_from_snapshot_and_clone +None will be restored to the state when the snapshot was created. +This attribute was added in vSphere API 8.0.0.0. +If set, the value is changed.

    • +
+
+
+
+ +
+
+create(vm, spec)
+

Creates a new data set. This method was added in vSphere API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (DataSets.CreateSpec) – Specification of the data set to be created.

    • +
+
+
Return type
+

str

+
+
Returns
+

The identifier of the new data set. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the data set with the same name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specification is incorrect.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is in a state that doesn’t allow +modifications, for example suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the new data set requires more resources than are available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetCreate.

    • +
+
+
+
+ +
+
+delete(vm, data_set, force=None)
+

Delete a data set. This method was added in vSphere API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set to be deleted. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +

  • force (bool or None) – If true, delete the data set even if it is not empty. +If None a com.vmware.vapi.std.errors_client.ResourceInUse +exception will be reported if the data set is not empty. This is +the equivalent of passing the value false.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is in a state that doesn’t allow +modifications, for example suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the data set is not empty and force is not set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetDelete.

    • +
+
+
+
+ +
+
+get(vm, data_set)
+

Returns information describing a data set. This method was added in +vSphere API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set to be queried. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +
+
+
Return type
+

DataSets.Info

+
+
Returns
+

Details about the data set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetGet.

    • +
+
+
+
+ +
+
+list(vm)
+

Lists the data sets of a virtual machine. This method was added in +vSphere API 8.0.0.0.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of DataSets.Summary

+
+
Returns
+

The list of data sets.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetList.

    • +
+
+
+
+ +
+
+update(vm, data_set, spec)
+

Modifies the attributes of a data set. This method was added in vSphere +API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set to be queried. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +

  • spec (DataSets.UpdateSpec) – new attributes of the data set. Data sets should only be modified +by the application that creates them. Otherwise the application may +stop working.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the new attributes are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is in a state that doesn’t allow +modification, for example suspendeds.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the new data set attributes requires more resources than are +available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetUpdate.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.GuestOS(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The GuestOS class defines the valid guest operating system types used +for configuring a virtual machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the GuestOS instance.

+
+
+
+
+ALMALINUX_64 = GuestOS(string='ALMALINUX_64')
+

AlmaLinux (64-bit). This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+AMAZONLINUX2_64 = GuestOS(string='AMAZONLINUX2_64')
+

Amazon Linux 2 (64 bit). This class attribute was added in vSphere API +6.7.1.

+
+ +
+
+AMAZONLINUX3_64 = GuestOS(string='AMAZONLINUX3_64')
+

Amazon Linux 3 (64 bit). This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+
+ASIANUX_3 = GuestOS(string='ASIANUX_3')
+

Asianux Server 3

+
+ +
+
+ASIANUX_3_64 = GuestOS(string='ASIANUX_3_64')
+

Asianux Server 3 (64 bit)

+
+ +
+
+ASIANUX_4 = GuestOS(string='ASIANUX_4')
+

Asianux Server 4

+
+ +
+
+ASIANUX_4_64 = GuestOS(string='ASIANUX_4_64')
+

Asianux Server 4 (64 bit)

+
+ +
+
+ASIANUX_5_64 = GuestOS(string='ASIANUX_5_64')
+

Asianux Server 5 (64 bit)

+
+ +
+
+ASIANUX_7_64 = GuestOS(string='ASIANUX_7_64')
+

Asianux Server 7 (64 bit)

+
+ +
+
+ASIANUX_8_64 = GuestOS(string='ASIANUX_8_64')
+

Asianux Server 8 (64 bit). This class attribute was added in vSphere API +6.7.

+
+ +
+
+ASIANUX_9_64 = GuestOS(string='ASIANUX_9_64')
+

Asianux Server 9 (64 bit). This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+
+CENTOS = GuestOS(string='CENTOS')
+

CentOS 4/5

+
+ +
+
+CENTOS_6 = GuestOS(string='CENTOS_6')
+

CentOS 6

+
+ +
+
+CENTOS_64 = GuestOS(string='CENTOS_64')
+

CentOS 4/5 (64-bit)

+
+ +
+
+CENTOS_6_64 = GuestOS(string='CENTOS_6_64')
+

CentOS 6 (64-bit)

+
+ +
+
+CENTOS_7 = GuestOS(string='CENTOS_7')
+

CentOS 7

+
+ +
+
+CENTOS_7_64 = GuestOS(string='CENTOS_7_64')
+

CentOS 7 (64-bit)

+
+ +
+
+CENTOS_8_64 = GuestOS(string='CENTOS_8_64')
+

CentOS 8 (64-bit). This class attribute was added in vSphere API 6.7.

+
+ +
+
+CENTOS_9_64 = GuestOS(string='CENTOS_9_64')
+

CentOS 9 (64-bit). This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+COREOS_64 = GuestOS(string='COREOS_64')
+

CoreOS Linux (64 bit)

+
+ +
+
+CRXPOD_1 = GuestOS(string='CRXPOD_1')
+

CRX Pod 1. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+DARWIN = GuestOS(string='DARWIN')
+

Mac OS 10.5

+
+ +
+
+DARWIN_10 = GuestOS(string='DARWIN_10')
+

Mac OS 10.6

+
+ +
+
+DARWIN_10_64 = GuestOS(string='DARWIN_10_64')
+

Mac OS 10.6 (64 bit)

+
+ +
+
+DARWIN_11 = GuestOS(string='DARWIN_11')
+

Mac OS 10.7

+
+ +
+
+DARWIN_11_64 = GuestOS(string='DARWIN_11_64')
+

Mac OS 10.7 (64 bit)

+
+ +
+
+DARWIN_12_64 = GuestOS(string='DARWIN_12_64')
+

Mac OS 10.8 (64 bit)

+
+ +
+
+DARWIN_13_64 = GuestOS(string='DARWIN_13_64')
+

Mac OS 10.9 (64 bit)

+
+ +
+
+DARWIN_14_64 = GuestOS(string='DARWIN_14_64')
+

Mac OS 10.10 (64 bit)

+
+ +
+
+DARWIN_15_64 = GuestOS(string='DARWIN_15_64')
+

Mac OS 10.11 (64 bit)

+
+ +
+
+DARWIN_16_64 = GuestOS(string='DARWIN_16_64')
+

Mac OS 10.12 (64 bit)

+
+ +
+
+DARWIN_17_64 = GuestOS(string='DARWIN_17_64')
+

Mac OS 10.13 (64 bit). This class attribute was added in vSphere API 6.7.

+
+ +
+
+DARWIN_18_64 = GuestOS(string='DARWIN_18_64')
+

Mac OS 10.14 (64 bit). This class attribute was added in vSphere API 6.7.

+
+ +
+
+DARWIN_19_64 = GuestOS(string='DARWIN_19_64')
+

Mac OS 10.15 (64 bit). This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+DARWIN_20_64 = GuestOS(string='DARWIN_20_64')
+

Mac OS 11 (64 bit). This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+DARWIN_21_64 = GuestOS(string='DARWIN_21_64')
+

Mac OS 12 (64 bit). This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+DARWIN_22_64 = GuestOS(string='DARWIN_22_64')
+

Mac OS 13 (64 bit). This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+DARWIN_23_64 = GuestOS(string='DARWIN_23_64')
+

Mac OS 14 (64 bit). This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+DARWIN_64 = GuestOS(string='DARWIN_64')
+

Mac OS 10.5 (64 bit)

+
+ +
+
+DEBIAN_10 = GuestOS(string='DEBIAN_10')
+

Debian GNU/Linux 10

+
+ +
+
+DEBIAN_10_64 = GuestOS(string='DEBIAN_10_64')
+

Debian GNU/Linux 10 (64 bit)

+
+ +
+
+DEBIAN_11 = GuestOS(string='DEBIAN_11')
+

Debian GNU/Linux 11. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+DEBIAN_11_64 = GuestOS(string='DEBIAN_11_64')
+

Debian GNU/Linux 11 (64 bit). This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+DEBIAN_12 = GuestOS(string='DEBIAN_12')
+

Debian GNU/Linux 12. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+DEBIAN_12_64 = GuestOS(string='DEBIAN_12_64')
+

Debian GNU/Linux 12 (64 bit). This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+DEBIAN_4 = GuestOS(string='DEBIAN_4')
+

Debian GNU/Linux 4

+
+ +
+
+DEBIAN_4_64 = GuestOS(string='DEBIAN_4_64')
+

Debian GNU/Linux 4 (64 bit)

+
+ +
+
+DEBIAN_5 = GuestOS(string='DEBIAN_5')
+

Debian GNU/Linux 5

+
+ +
+
+DEBIAN_5_64 = GuestOS(string='DEBIAN_5_64')
+

Debian GNU/Linux 5 (64 bit)

+
+ +
+
+DEBIAN_6 = GuestOS(string='DEBIAN_6')
+

Debian GNU/Linux 6

+
+ +
+
+DEBIAN_6_64 = GuestOS(string='DEBIAN_6_64')
+

Debian GNU/Linux 6 (64 bit)

+
+ +
+
+DEBIAN_7 = GuestOS(string='DEBIAN_7')
+

Debian GNU/Linux 7

+
+ +
+
+DEBIAN_7_64 = GuestOS(string='DEBIAN_7_64')
+

Debian GNU/Linux 7 (64 bit)

+
+ +
+
+DEBIAN_8 = GuestOS(string='DEBIAN_8')
+

Debian GNU/Linux 8

+
+ +
+
+DEBIAN_8_64 = GuestOS(string='DEBIAN_8_64')
+

Debian GNU/Linux 8 (64 bit)

+
+ +
+
+DEBIAN_9 = GuestOS(string='DEBIAN_9')
+

Debian GNU/Linux 9

+
+ +
+
+DEBIAN_9_64 = GuestOS(string='DEBIAN_9_64')
+

Debian GNU/Linux 9 (64 bit)

+
+ +
+
+DOS = GuestOS(string='DOS')
+

MS-DOS.

+
+ +
+
+ECOMSTATION = GuestOS(string='ECOMSTATION')
+

eComStation 1.x

+
+ +
+
+ECOMSTATION_2 = GuestOS(string='ECOMSTATION_2')
+

eComStation 2.0

+
+ +
+
+FEDORA = GuestOS(string='FEDORA')
+

Fedora Linux

+
+ +
+
+FEDORA_64 = GuestOS(string='FEDORA_64')
+

Fedora Linux (64 bit)

+
+ +
+
+FREEBSD = GuestOS(string='FREEBSD')
+

FreeBSD 10 or earlier

+
+ +
+
+FREEBSD_11 = GuestOS(string='FREEBSD_11')
+

FreeBSD 11. This class attribute was added in vSphere API 6.7.

+
+ +
+
+FREEBSD_11_64 = GuestOS(string='FREEBSD_11_64')
+

FreeBSD 11 x64. This class attribute was added in vSphere API 6.7.

+
+ +
+
+FREEBSD_12 = GuestOS(string='FREEBSD_12')
+

FreeBSD 12. This class attribute was added in vSphere API 6.7.

+
+ +
+
+FREEBSD_12_64 = GuestOS(string='FREEBSD_12_64')
+

FreeBSD 12 x64. This class attribute was added in vSphere API 6.7.

+
+ +
+
+FREEBSD_13 = GuestOS(string='FREEBSD_13')
+

FreeBSD 13. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+FREEBSD_13_64 = GuestOS(string='FREEBSD_13_64')
+

FreeBSD 13 x64. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+FREEBSD_14 = GuestOS(string='FREEBSD_14')
+

FreeBSD 14 or later. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+FREEBSD_14_64 = GuestOS(string='FREEBSD_14_64')
+

FreeBSD 14 x64 or later. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+FREEBSD_64 = GuestOS(string='FREEBSD_64')
+

FreeBSD 10 x64 or earlier

+
+ +
+
+GENERIC_LINUX = GuestOS(string='GENERIC_LINUX')
+

Other Linux

+
+ +
+
+MANDRAKE = GuestOS(string='MANDRAKE')
+

Mandrake Linux

+
+ +
+
+MANDRIVA = GuestOS(string='MANDRIVA')
+

Mandriva Linux

+
+ +
+
+MANDRIVA_64 = GuestOS(string='MANDRIVA_64')
+

Mandriva Linux (64 bit)

+
+ +
+
+NETWARE_4 = GuestOS(string='NETWARE_4')
+

Novell NetWare 4

+
+ +
+
+NETWARE_5 = GuestOS(string='NETWARE_5')
+

Novell NetWare 5.1

+
+ +
+
+NETWARE_6 = GuestOS(string='NETWARE_6')
+

Novell NetWare 6.x

+
+ +
+
+NLD_9 = GuestOS(string='NLD_9')
+

Novell Linux Desktop 9

+
+ +
+
+OES = GuestOS(string='OES')
+

Open Enterprise Server

+
+ +
+
+OPENSERVER_5 = GuestOS(string='OPENSERVER_5')
+

SCO OpenServer 5

+
+ +
+
+OPENSERVER_6 = GuestOS(string='OPENSERVER_6')
+

SCO OpenServer 6

+
+ +
+
+OPENSUSE = GuestOS(string='OPENSUSE')
+

OpenSUSE Linux

+
+ +
+
+OPENSUSE_64 = GuestOS(string='OPENSUSE_64')
+

OpenSUSE Linux (64 bit)

+
+ +
+
+ORACLE_LINUX = GuestOS(string='ORACLE_LINUX')
+

Oracle Linux 4/5

+
+ +
+
+ORACLE_LINUX_6 = GuestOS(string='ORACLE_LINUX_6')
+

Oracle Linux 6

+
+ +
+
+ORACLE_LINUX_64 = GuestOS(string='ORACLE_LINUX_64')
+

Oracle Linux 4/5 (64-bit)

+
+ +
+
+ORACLE_LINUX_6_64 = GuestOS(string='ORACLE_LINUX_6_64')
+

Oracle Linux 6 (64-bit)

+
+ +
+
+ORACLE_LINUX_7 = GuestOS(string='ORACLE_LINUX_7')
+

Oracle Linux 7

+
+ +
+
+ORACLE_LINUX_7_64 = GuestOS(string='ORACLE_LINUX_7_64')
+

Oracle Linux 7 (64-bit)

+
+ +
+
+ORACLE_LINUX_8_64 = GuestOS(string='ORACLE_LINUX_8_64')
+

Oracle Linux 8 (64-bit). This class attribute was added in vSphere API 6.7.

+
+ +
+
+ORACLE_LINUX_9_64 = GuestOS(string='ORACLE_LINUX_9_64')
+

Oracle Linux 9 (64-bit). This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+
+OS2 = GuestOS(string='OS2')
+

OS/2

+
+ +
+
+OTHER = GuestOS(string='OTHER')
+

Other Operating System

+
+ +
+
+OTHER_24X_LINUX = GuestOS(string='OTHER_24X_LINUX')
+

Linux 2.4x Kernel

+
+ +
+
+OTHER_24X_LINUX_64 = GuestOS(string='OTHER_24X_LINUX_64')
+

Linux 2.4x Kernel (64 bit)

+
+ +
+
+OTHER_26X_LINUX = GuestOS(string='OTHER_26X_LINUX')
+

Linux 2.6x Kernel

+
+ +
+
+OTHER_26X_LINUX_64 = GuestOS(string='OTHER_26X_LINUX_64')
+

Linux 2.6x Kernel (64 bit)

+
+ +
+
+OTHER_3X_LINUX = GuestOS(string='OTHER_3X_LINUX')
+

Linux 3.x Kernel

+
+ +
+
+OTHER_3X_LINUX_64 = GuestOS(string='OTHER_3X_LINUX_64')
+

Linux 3.x Kernel (64 bit)

+
+ +
+
+OTHER_4X_LINUX = GuestOS(string='OTHER_4X_LINUX')
+

Linux 4.x Kernel. This class attribute was added in vSphere API 6.7.

+
+ +
+
+OTHER_4X_LINUX_64 = GuestOS(string='OTHER_4X_LINUX_64')
+

Linux 4.x Kernel (64 bit). This class attribute was added in vSphere API +6.7.

+
+ +
+
+OTHER_5X_LINUX = GuestOS(string='OTHER_5X_LINUX')
+

Linux 5.x Kernel. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+OTHER_5X_LINUX_64 = GuestOS(string='OTHER_5X_LINUX_64')
+

Linux 5.x Kernel (64 bit). This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+
+OTHER_64 = GuestOS(string='OTHER_64')
+

Other Operating System (64 bit)

+
+ +
+
+OTHER_6X_LINUX = GuestOS(string='OTHER_6X_LINUX')
+

Linux 6.x Kernel. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+OTHER_6X_LINUX_64 = GuestOS(string='OTHER_6X_LINUX_64')
+

Linux 6.x Kernel (64 bit). This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+OTHER_LINUX = GuestOS(string='OTHER_LINUX')
+

Linux 2.2x Kernel

+
+ +
+
+OTHER_LINUX_64 = GuestOS(string='OTHER_LINUX_64')
+

Linux (64 bit)

+
+ +
+
+REDHAT = GuestOS(string='REDHAT')
+

Red Hat Linux 2.1

+
+ +
+
+RHEL_2 = GuestOS(string='RHEL_2')
+

Red Hat Enterprise Linux 2

+
+ +
+
+RHEL_3 = GuestOS(string='RHEL_3')
+

Red Hat Enterprise Linux 3

+
+ +
+
+RHEL_3_64 = GuestOS(string='RHEL_3_64')
+

Red Hat Enterprise Linux 3 (64 bit)

+
+ +
+
+RHEL_4 = GuestOS(string='RHEL_4')
+

Red Hat Enterprise Linux 4

+
+ +
+
+RHEL_4_64 = GuestOS(string='RHEL_4_64')
+

Red Hat Enterprise Linux 4 (64 bit)

+
+ +
+
+RHEL_5 = GuestOS(string='RHEL_5')
+

Red Hat Enterprise Linux 5

+
+ +
+
+RHEL_5_64 = GuestOS(string='RHEL_5_64')
+

Red Hat Enterprise Linux 5 (64 bit)

+
+ +
+
+RHEL_6 = GuestOS(string='RHEL_6')
+

Red Hat Enterprise Linux 6

+
+ +
+
+RHEL_6_64 = GuestOS(string='RHEL_6_64')
+

Red Hat Enterprise Linux 6 (64 bit)

+
+ +
+
+RHEL_7 = GuestOS(string='RHEL_7')
+

Red Hat Enterprise Linux 7

+
+ +
+
+RHEL_7_64 = GuestOS(string='RHEL_7_64')
+

Red Hat Enterprise Linux 7 (64 bit)

+
+ +
+
+RHEL_8_64 = GuestOS(string='RHEL_8_64')
+

Red Hat Enterprise Linux 8 (64 bit). This class attribute was added in +vSphere API 6.7.

+
+ +
+
+RHEL_9_64 = GuestOS(string='RHEL_9_64')
+

Red Hat Enterprise Linux 9 (64 bit). This class attribute was added in +vSphere API 7.0.1.0.

+
+ +
+
+ROCKYLINUX_64 = GuestOS(string='ROCKYLINUX_64')
+

Rocky Linux (64-bit). This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SJDS = GuestOS(string='SJDS')
+

Sun Java Desktop System

+
+ +
+
+SLES = GuestOS(string='SLES')
+

Suse Linux Enterprise Server 9

+
+ +
+
+SLES_10 = GuestOS(string='SLES_10')
+

Suse linux Enterprise Server 10

+
+ +
+
+SLES_10_64 = GuestOS(string='SLES_10_64')
+

Suse Linux Enterprise Server 10 (64 bit)

+
+ +
+
+SLES_11 = GuestOS(string='SLES_11')
+

Suse linux Enterprise Server 11

+
+ +
+
+SLES_11_64 = GuestOS(string='SLES_11_64')
+

Suse Linux Enterprise Server 11 (64 bit)

+
+ +
+
+SLES_12 = GuestOS(string='SLES_12')
+

Suse linux Enterprise Server 12

+
+ +
+
+SLES_12_64 = GuestOS(string='SLES_12_64')
+

Suse Linux Enterprise Server 12 (64 bit)

+
+ +
+
+SLES_15_64 = GuestOS(string='SLES_15_64')
+

Suse Linux Enterprise Server 15 (64 bit). This class attribute was added in +vSphere API 6.7.

+
+ +
+
+SLES_16_64 = GuestOS(string='SLES_16_64')
+

Suse Linux Enterprise Server 16 (64 bit). This class attribute was added in +vSphere API 7.0.1.0.

+
+ +
+
+SLES_64 = GuestOS(string='SLES_64')
+

Suse Linux Enterprise Server 9 (64 bit)

+
+ +
+
+SOLARIS_10 = GuestOS(string='SOLARIS_10')
+

Solaris 10 (32 bit)

+
+ +
+
+SOLARIS_10_64 = GuestOS(string='SOLARIS_10_64')
+

Solaris 10 (64 bit)

+
+ +
+
+SOLARIS_11_64 = GuestOS(string='SOLARIS_11_64')
+

Solaris 11 (64 bit)

+
+ +
+
+SOLARIS_6 = GuestOS(string='SOLARIS_6')
+

Solaris 6

+
+ +
+
+SOLARIS_7 = GuestOS(string='SOLARIS_7')
+

Solaris 7

+
+ +
+
+SOLARIS_8 = GuestOS(string='SOLARIS_8')
+

Solaris 8

+
+ +
+
+SOLARIS_9 = GuestOS(string='SOLARIS_9')
+

Solaris 9

+
+ +
+
+SUSE = GuestOS(string='SUSE')
+

Suse Linux

+
+ +
+
+SUSE_64 = GuestOS(string='SUSE_64')
+

Suse Linux (64 bit)

+
+ +
+
+TURBO_LINUX = GuestOS(string='TURBO_LINUX')
+

Turbolinux

+
+ +
+
+TURBO_LINUX_64 = GuestOS(string='TURBO_LINUX_64')
+

Turbolinux (64 bit)

+
+ +
+
+UBUNTU = GuestOS(string='UBUNTU')
+

Ubuntu Linux

+
+ +
+
+UBUNTU_64 = GuestOS(string='UBUNTU_64')
+

Ubuntu Linux (64 bit)

+
+ +
+
+UNIXWARE_7 = GuestOS(string='UNIXWARE_7')
+

SCO UnixWare 7

+
+ +
+
+VMKERNEL = GuestOS(string='VMKERNEL')
+

VMware ESX 4

+
+ +
+
+VMKERNEL_5 = GuestOS(string='VMKERNEL_5')
+

VMware ESX 5

+
+ +
+
+VMKERNEL_6 = GuestOS(string='VMKERNEL_6')
+

VMware ESX 6

+
+ +
+
+VMKERNEL_65 = GuestOS(string='VMKERNEL_65')
+

VMware ESXi 6.5 AND ESXi 6.7.

+
+ +
+
+VMKERNEL_7 = GuestOS(string='VMKERNEL_7')
+

VMware ESX 7. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+VMKERNEL_8 = GuestOS(string='VMKERNEL_8')
+

VMware ESX 8. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+VMWARE_PHOTON_64 = GuestOS(string='VMWARE_PHOTON_64')
+

VMware Photon (64 bit)

+
+ +
+
+WINDOWS_11_64 = GuestOS(string='WINDOWS_11_64')
+

Windows 11 (64 bit). This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+WINDOWS_12_64 = GuestOS(string='WINDOWS_12_64')
+

Windows 12 (64 bit). This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+WINDOWS_7 = GuestOS(string='WINDOWS_7')
+

Windows 7

+
+ +
+
+WINDOWS_7_64 = GuestOS(string='WINDOWS_7_64')
+

Windows 7 (64 bit)

+
+ +
+
+WINDOWS_7_SERVER_64 = GuestOS(string='WINDOWS_7_SERVER_64')
+

Windows Server 2008 R2 (64 bit)

+
+ +
+
+WINDOWS_8 = GuestOS(string='WINDOWS_8')
+

Windows 8

+
+ +
+
+WINDOWS_8_64 = GuestOS(string='WINDOWS_8_64')
+

Windows 8 (64 bit)

+
+ +
+
+WINDOWS_8_SERVER_64 = GuestOS(string='WINDOWS_8_SERVER_64')
+

Windows 8 Server (64 bit)

+
+ +
+
+WINDOWS_9 = GuestOS(string='WINDOWS_9')
+

Windows 10

+
+ +
+
+WINDOWS_9_64 = GuestOS(string='WINDOWS_9_64')
+

Windows 10 (64 bit)

+
+ +
+
+WINDOWS_9_SERVER_64 = GuestOS(string='WINDOWS_9_SERVER_64')
+

Windows 10 Server (64 bit)

+
+ +
+
+WINDOWS_HYPERV = GuestOS(string='WINDOWS_HYPERV')
+

Windows Hyper-V

+
+ +
+
+WINDOWS_SERVER_2019 = GuestOS(string='WINDOWS_SERVER_2019')
+

Windows Server 2019. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+WINDOWS_SERVER_2021 = GuestOS(string='WINDOWS_SERVER_2021')
+

Windows Server 2022. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+WINDOWS_SERVER_2025 = GuestOS(string='WINDOWS_SERVER_2025')
+

Windows Server 2025. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+WIN_2000_ADV_SERV = GuestOS(string='WIN_2000_ADV_SERV')
+

Windows 2000 Advanced Server

+
+ +
+
+WIN_2000_PRO = GuestOS(string='WIN_2000_PRO')
+

Windows 2000 Professional

+
+ +
+
+WIN_2000_SERV = GuestOS(string='WIN_2000_SERV')
+

Windows 2000 Server

+
+ +
+
+WIN_31 = GuestOS(string='WIN_31')
+

Windows 3.1

+
+ +
+
+WIN_95 = GuestOS(string='WIN_95')
+

Windows 95

+
+ +
+
+WIN_98 = GuestOS(string='WIN_98')
+

Windows 98

+
+ +
+
+WIN_LONGHORN = GuestOS(string='WIN_LONGHORN')
+

Windows Longhorn

+
+ +
+
+WIN_LONGHORN_64 = GuestOS(string='WIN_LONGHORN_64')
+

Windows Longhorn (64 bit)

+
+ +
+
+WIN_ME = GuestOS(string='WIN_ME')
+

Windows Millennium Edition

+
+ +
+
+WIN_NET_BUSINESS = GuestOS(string='WIN_NET_BUSINESS')
+

Windows Small Business Server 2003

+
+ +
+
+WIN_NET_DATACENTER = GuestOS(string='WIN_NET_DATACENTER')
+

Windows Server 2003, Datacenter Edition

+
+ +
+
+WIN_NET_DATACENTER_64 = GuestOS(string='WIN_NET_DATACENTER_64')
+

Windows Server 2003, Datacenter Edition (64 bit)

+
+ +
+
+WIN_NET_ENTERPRISE = GuestOS(string='WIN_NET_ENTERPRISE')
+

Windows Server 2003, Enterprise Edition

+
+ +
+
+WIN_NET_ENTERPRISE_64 = GuestOS(string='WIN_NET_ENTERPRISE_64')
+

Windows Server 2003, Enterprise Edition (64 bit)

+
+ +
+
+WIN_NET_STANDARD = GuestOS(string='WIN_NET_STANDARD')
+

Windows Server 2003, Standard Edition

+
+ +
+
+WIN_NET_STANDARD_64 = GuestOS(string='WIN_NET_STANDARD_64')
+

Windows Server 2003, Standard Edition (64 bit)

+
+ +
+
+WIN_NET_WEB = GuestOS(string='WIN_NET_WEB')
+

Windows Server 2003, Web Edition

+
+ +
+
+WIN_NT = GuestOS(string='WIN_NT')
+

Windows NT 4

+
+ +
+
+WIN_VISTA = GuestOS(string='WIN_VISTA')
+

Windows Vista

+
+ +
+
+WIN_VISTA_64 = GuestOS(string='WIN_VISTA_64')
+

Windows Vista (64 bit)

+
+ +
+
+WIN_XP_HOME = GuestOS(string='WIN_XP_HOME')
+

Windows XP Home Edition

+
+ +
+
+WIN_XP_PRO = GuestOS(string='WIN_XP_PRO')
+

Windows XP Professional

+
+ +
+
+WIN_XP_PRO_64 = GuestOS(string='WIN_XP_PRO_64')
+

Windows XP Professional Edition (64 bit)

+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.GuestOSFamily(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The GuestOSFamily class defines the valid guest operating system family +types reported by a virtual machine. This enumeration was added in vSphere +API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the GuestOSFamily instance.

+
+
+
+
+DARWIN = GuestOSFamily(string='DARWIN')
+

Mac OS operating system. This class attribute was added in vSphere API 6.7.

+
+ +
+
+LINUX = GuestOSFamily(string='LINUX')
+

Linux operating system. This class attribute was added in vSphere API 6.7.

+
+ +
+
+NETWARE = GuestOSFamily(string='NETWARE')
+

Novell Netware. This class attribute was added in vSphere API 6.7.

+
+ +
+
+OTHER = GuestOSFamily(string='OTHER')
+

Other operating systems. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SOLARIS = GuestOSFamily(string='SOLARIS')
+

Solaris operating system. This class attribute was added in vSphere API +6.7.

+
+ +
+
+WINDOWS = GuestOSFamily(string='WINDOWS')
+

Windows operating system. This class attribute was added in vSphere API +6.7.

+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.Hardware(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Hardware class provides methods for configuring the virtual +hardware of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(version=None, upgrade_policy=None, upgrade_version=None, upgrade_status=None, upgrade_error=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Hardware.Info class contains information related to the virtual +hardware of a virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class UpdateSpec(upgrade_policy=None, upgrade_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Hardware.UpdateSpec class describes the updates to virtual hardware +settings of a virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • upgrade_policy (Hardware.UpgradePolicy or None) –

    Scheduled upgrade policy.

    +

    If set to Hardware.UpgradePolicy.NEVER, the +Hardware.Info.upgrade_version attribute will be reset to +None. +If None, the value is unchanged.

    +

    • +

  • upgrade_version (Hardware.Version or None) –

    Target hardware version to be used on the next scheduled virtual +hardware upgrade.

    +

    If specified, this attribute must represent a newer virtual +hardware version than the current virtual hardware version reported +in Hardware.Info.version. +If Hardware.UpdateSpec.upgrade_policy is set to +Hardware.UpgradePolicy.NEVER, this attribute must be None. +Otherwise, if this attribute is None, default to the most recent +virtual hardware version supported by the server.

    +

    • +
+
+
+
+ +
+
+class UpgradePolicy(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Hardware.UpgradePolicy class defines the valid virtual hardware +upgrade policies for a virtual machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UpgradePolicy instance.

+
+
+
+
+AFTER_CLEAN_SHUTDOWN = UpgradePolicy(string='AFTER_CLEAN_SHUTDOWN')
+

Run scheduled upgrade when the virtual machine is powered on after a clean +shutdown of the guest operating system.

+
+ +
+
+ALWAYS = UpgradePolicy(string='ALWAYS')
+

Run scheduled upgrade when the virtual machine is powered on.

+
+ +
+
+NEVER = UpgradePolicy(string='NEVER')
+

Do not upgrade the virtual machine when it is powered on.

+
+ +
+ +
+
+class UpgradeStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Hardware.UpgradeStatus class defines the valid virtual hardware +upgrade statuses for a virtual machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UpgradeStatus instance.

+
+
+
+
+FAILED = UpgradeStatus(string='FAILED')
+

The most recent scheduled upgrade was not successful.

+
+ +
+
+NONE = UpgradeStatus(string='NONE')
+

No scheduled upgrade has been attempted.

+
+ +
+
+PENDING = UpgradeStatus(string='PENDING')
+

Upgrade is scheduled but has not yet been run.

+
+ +
+
+SUCCESS = UpgradeStatus(string='SUCCESS')
+

The most recent scheduled upgrade was successful.

+
+ +
+ +
+
+class Version(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Hardware.Version class defines the valid virtual hardware versions +for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual +machine hardware versions (1003746)).

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Version instance.

+
+
+
+
+VMX_03 = Version(string='VMX_03')
+

Hardware version 3, first supported in ESXi 2.5.

+
+ +
+
+VMX_04 = Version(string='VMX_04')
+

Hardware version 4, first supported in ESXi 3.0.

+
+ +
+
+VMX_06 = Version(string='VMX_06')
+

Hardware version 6, first supported in WS 6.0.

+
+ +
+
+VMX_07 = Version(string='VMX_07')
+

Hardware version 7, first supported in ESXi 4.0.

+
+ +
+
+VMX_08 = Version(string='VMX_08')
+

Hardware version 8, first supported in ESXi 5.0.

+
+ +
+
+VMX_09 = Version(string='VMX_09')
+

Hardware version 9, first supported in ESXi 5.1.

+
+ +
+
+VMX_10 = Version(string='VMX_10')
+

Hardware version 10, first supported in ESXi 5.5.

+
+ +
+
+VMX_11 = Version(string='VMX_11')
+

Hardware version 11, first supported in ESXi 6.0.

+
+ +
+
+VMX_12 = Version(string='VMX_12')
+

Hardware version 12, first supported in Workstation 12.0.

+
+ +
+
+VMX_13 = Version(string='VMX_13')
+

Hardware version 13, first supported in ESXi 6.5.

+
+ +
+
+VMX_14 = Version(string='VMX_14')
+

Hardware version 14, first supported in ESXi 6.7. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+VMX_15 = Version(string='VMX_15')
+

Hardware version 15, first supported in ESXi 6.7 Update 2. This class +attribute was added in vSphere API 6.7.2.

+
+ +
+
+VMX_16 = Version(string='VMX_16')
+

Hardware version 16, first supported in Workstation 15.0. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+VMX_17 = Version(string='VMX_17')
+

Hardware version 17, first supported in ESXi 7.0.0-0. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+VMX_18 = Version(string='VMX_18')
+

Hardware version 18, first supported in ESXi 7.0 U1. This class attribute +was added in vSphere API 7.0.1.0.

+
+ +
+
+VMX_19 = Version(string='VMX_19')
+

Hardware version 19, first supported in ESXi 7.0 U2. This class attribute +was added in vSphere API 7.0.2.0.

+
+ +
+
+VMX_20 = Version(string='VMX_20')
+

Hardware version 20, first supported in ESXi 8.0.0.1. This class attribute +was added in vSphere API 8.0.0.1.

+
+ +
+
+VMX_21 = Version(string='VMX_21')
+

Hardware version 21, first supported in ESXi 8.0 U2. This class attribute +was added in vSphere API 8.0.2.0.

+
+ +
+ +
+
+get(vm)
+

Returns the virtual hardware settings of a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Hardware.Info

+
+
Returns
+

Virtual hardware settings of the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, spec)
+

Updates the virtual hardware settings of a virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Hardware.UpdateSpec) – Specification for updating the virtual hardware settings of the +virtual machine.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is already configured for the desired +hardware version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the requested virtual hardware version is not newer than the +current version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the requested virtual hardware version is not supported by the +server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+upgrade(vm, version=None)
+

Upgrades the virtual machine to a newer virtual hardware version.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • version (Hardware.Version or None) – New virtual machine version. +If None, defaults to the most recent virtual hardware version +supported by the server.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is already configured for the desired +hardware version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if version is older than the current virtual hardware version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if version is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.Identity(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Identity class provides methods for managing the identity of a +virtual machine. This class was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(name=None, bios_uuid=None, instance_uuid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Identity.Info class contains information about the identity of a +virtual machine. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Virtual machine name. This attribute was added in vSphere API +6.7.1.

    • +

  • bios_uuid (str) – 128-bit SMBIOS UUID of a virtual machine represented as a +hexadecimal string in “12345678-abcd-1234-cdef-123456789abc” +format. This attribute was added in vSphere API 6.7.1.

    • +

  • instance_uuid (str) – VirtualCenter-specific 128-bit UUID of a virtual machine, +represented as a hexademical string. This identifier is used by +VirtualCenter to uniquely identify all virtual machine instances, +including those that may share the same SMBIOS UUID. This attribute +was added in vSphere API 6.7.1.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.LibraryItem(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LibraryItem class provides methods to identify virtual machines +managed by Content Library. This class was added in vSphere API 6.9.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckOutInfo(library_item=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.CheckOutInfo class contains information about a virtual +machine checked out of a content library item. This class was added in +vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

library_item (str) – Identifier of the library item that the virtual machine is checked +out from. 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: +com.vmware.content.library.Item. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.content.library.Item.

+
+
+
+ +
+
+class Info(check_out=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItem.Info class contains information about the library item +associated with a virtual machine. This class was added in vSphere API +6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

check_out (LibraryItem.CheckOutInfo or None) – Information about the checked out virtual machine. This attribute +was added in vSphere API 6.9.1. +If None, the virtual machine is not checked out from a library +item.

+
+
+
+ +
+
+get(vm)
+

Returns the information about the library item associated with the +virtual machine. This method was added in vSphere API 6.9.1.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

LibraryItem.Info

+
+
Returns
+

Information about the library item associated with the virtual +machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.Power(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Power class provides methods for managing the power state of a +virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(state=None, clean_power_off=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Power.Info class contains information about the power state of a +virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (Power.State) – Power state of the virtual machine.

    • +

  • clean_power_off (bool) – Flag indicating whether the virtual machine was powered off +cleanly. This attribute may be used to detect that the virtual +machine crashed unexpectedly and should be restarted. +This attribute is optional and it is only relevant when the value +of state is Power.State.POWERED_OFF.

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Power.State class defines the valid power states for a virtual +machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+POWERED_OFF = State(string='POWERED_OFF')
+

The virtual machine is powered off.

+
+ +
+
+POWERED_ON = State(string='POWERED_ON')
+

The virtual machine is powered on.

+
+ +
+
+SUSPENDED = State(string='SUSPENDED')
+

The virtual machine is suspended.

+
+ +
+ +
+
+get(vm)
+

Returns the power state information of a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Power.Info

+
+
Returns
+

Power state information for the specified virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration or execution state cannot be +accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires System.Read.

    • +
+
+
+
+ +
+
+reset(vm)
+

Resets a powered-on virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is powered off or suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Interact.Reset.

    • +
+
+
+
+ +
+
+start(vm)
+

Powers on a powered-off or suspended virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is already powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual machine does not support being powered on (e.g. +marked as a template, serving as a fault-tolerance secondary +virtual machine).

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if resources cannot be allocated for the virtual machine (e.g. +physical resource allocation policy cannot be satisfied, +insufficient licenses are available to run the virtual machine).

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if resources required by the virtual machine are not accessible +(e.g. virtual machine configuration files or virtual disks are on +inaccessible storage, no hosts are available to run the virtual +machine).

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if resources required by the virtual machine are in use (e.g. +virtual machine configuration files or virtual disks are locked, +host containing the virtual machine is an HA failover host).

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Interact.PowerOn.

    • +
+
+
+
+ +
+
+stop(vm)
+

Powers off a powered-on or suspended virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is already powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Interact.PowerOff.

    • +
+
+
+
+ +
+
+suspend(vm)
+

Suspends a powered-on virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is already suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Interact.Suspend.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.vm_client.Tools(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Tools class provides methods for managing VMware Tools in the guest +operating system. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(auto_update_supported=None, install_attempt_count=None, error=None, version_number=None, version=None, upgrade_policy=None, version_status=None, install_type=None, run_state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tools.Info class describes the VMWare Tools properties of a virtual +machine. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • auto_update_supported (bool) – Set if the virtual machine supports auto-upgrading Tools via +Tools.UpgradePolicy. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • install_attempt_count (long or None) – Number of attempts that have been made to install or upgrade the +version of Tools installed on this virtual machine. This attribute +was added in vSphere API 7.0.0.0. +This attribute will be None if there have been no Tools install or +upgrade attempt.

    • +

  • error (Exception or None) – Error that happened, if any, during last attempt to upgrade or +install Tools. This attribute was added in vSphere API 7.0.0.0. +This attribute will be None if a the last Tools install or upgrade +attempt succeeded.

    • +

  • version_number (long or None) – Version of VMware Tools installed on the guest operating system. +This attribute was added in vSphere API 7.0.0.0. +This attribute wil be None if VMWare Tools is not installed. This +is an integer constructed as follows: (((MJR) << 10) + ((MNR) << 5) ++ (REV)) Where MJR is tha major verson, MNR is the minor version +and REV is the revision. Tools version = T Tools Version Major = +MJR = (T / 1024) Tools Version Minor = MNR = ((T % 1024) / 32) +Tools Version Revision = BASE = ((T % 1024) % 32) Tools actual +version = MJR.MNR.REV

    • +

  • version (str or None) – Version of VMware Tools installed on the guest operating system. +This is a human-readable value that should not be parsed. This +attribute was added in vSphere API 7.0.0.0. +This attribute wil be None if VMWare Tools is not installed.

    • +

  • upgrade_policy (Tools.UpgradePolicy) – Tools upgrade policy setting for the virtual machine. +Tools.UpgradePolicy. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • version_status (Tools.VersionStatus or None) – Current version status of VMware Tools in the guest operating +system, if known. This attribute was added in vSphere API 7.0.0.0. +This attribute will be None if the version status is not known, for +example if VMware Tools is too old to report the information.

    • +

  • install_type (Tools.ToolsInstallType or None) – Current installation type of VMware Tools in the guest operating +system. This attribute was added in vSphere API 7.0.0.0. +This attribute will be None if the installation type is not known, +for example if VMware Tools is too old to report the information.

    • +

  • run_state (Tools.RunState) – Current run state of VMware Tools in the guest operating system. +This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class RunState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Current run state of VMware Tools in the guest operating system. This +enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the RunState instance.

+
+
+
+
+EXECUTING_SCRIPTS = RunState(string='EXECUTING_SCRIPTS')
+

VMware Tools is running scripts as part of a state transition. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+NOT_RUNNING = RunState(string='NOT_RUNNING')
+

VMware Tools is not running. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+RUNNING = RunState(string='RUNNING')
+

VMware Tools is running. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+ +
+
+class ToolsInstallType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Tools.ToolsInstallType class defines the installation type of the +Tools in the guest operating system. This enumeration was added in vSphere +API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ToolsInstallType instance.

+
+
+
+
+MSI = ToolsInstallType(string='MSI')
+

MSI is the installation type used for VMware Tools on Windows. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OPEN_VM_TOOLS = ToolsInstallType(string='OPEN_VM_TOOLS')
+

open-vm-tools are the open-source version of VMware Tools, may have been +packaged by the OS vendor. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+OSP = ToolsInstallType(string='OSP')
+

OSPs are RPM or Debian packages tailored for the OS in the VM. See +http://packages.vmware.com. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+TAR = ToolsInstallType(string='TAR')
+

Tools have been installed by the tar installer. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+UNKNOWN = ToolsInstallType(string='UNKNOWN')
+

Installation type is not known. Most likely tools have been installed by +OSPs or open-vm-tools, but a version that does not report its install type +or an install type that we do not recognize. This class attribute was added +in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class UpdateSpec(upgrade_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The (\@name UpdateSpec} class describes the VMware Tools properties of a +virtual machine that can be updated. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

upgrade_policy (Tools.UpgradePolicy or None) – Tools upgrade policy setting for the virtual machine. +Tools.UpgradePolicy. This attribute was added in vSphere +API 7.0.0.0. +If None the upgrade policy will not be modified.

+
+
+
+ +
+
+class UpgradePolicy(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Tools.UpgradePolicy class defines when Tools are auto-upgraded for +a virtual machine. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UpgradePolicy instance.

+
+
+
+
+MANUAL = UpgradePolicy(string='MANUAL')
+

No auto-upgrades for Tools will be performed for this virtual machine. +Users must manually invoke the Tools.upgrade() method to update +Tools. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+UPGRADE_AT_POWER_CYCLE = UpgradePolicy(string='UPGRADE_AT_POWER_CYCLE')
+

When the virtual machine is power-cycled, the system checks for a newer +version of Tools when the virtual machine is powered on. If it is +available, a Tools upgrade is automatically performed on the virtual +machine and it is rebooted if necessary. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+ +
+
+class VersionStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Tools.VersionStatus class defines the version status types of +VMware Tools installed in the guest operating system. This enumeration was +added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the VersionStatus instance.

+
+
+
+
+BLACKLISTED = VersionStatus(string='BLACKLISTED')
+

VMware Tools is installed, but the installed version is known to have a +grave bug and should be immediately upgraded. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+CURRENT = VersionStatus(string='CURRENT')
+

VMware Tools is installed, and the version is current. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+NOT_INSTALLED = VersionStatus(string='NOT_INSTALLED')
+

VMware Tools has never been installed. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+SUPPORTED_NEW = VersionStatus(string='SUPPORTED_NEW')
+

VMware Tools is installed, supported, and newer than the version available +on the host. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SUPPORTED_OLD = VersionStatus(string='SUPPORTED_OLD')
+

VMware Tools is installed, supported, but a newer version is available. +This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+TOO_NEW = VersionStatus(string='TOO_NEW')
+

VMware Tools is installed, and the version is known to be too new to work +correctly with this virtual machine. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+TOO_OLD_UNSUPPORTED = VersionStatus(string='TOO_OLD_UNSUPPORTED')
+

VMware Tools is installed, but the version is too old. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+UNMANAGED = VersionStatus(string='UNMANAGED')
+

VMware Tools is installed, but it is not managed by VMware. This includes +open-vm-tools or OSPs which should be managed by the guest operating +system. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+get(vm)
+

Get the properties of VMware Tools. This method was added in vSphere +API 7.0.0.0.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Tools.Info

+
+
Returns
+

VMware Tools properties.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+
+update(vm, spec)
+

Update the properties of VMware Tools. This method was added in vSphere +API 7.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Tools.UpdateSpec) – The new values.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Tools.UpdateSpec.upgrade_policy attribute contains a +value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+
+upgrade(vm, command_line_options=None)
+

Begins the Tools upgrade process. To monitor the status of the Tools +upgrade, clients should check the Tools status by calling +Tools.get() and examining versionStatus and runState. +This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • command_line_options (str or None) – Command line options passed to the installer to modify the +installation procedure for Tools. +Set if any additional options are desired.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +is an upgrade is already in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the upgrade process fails inside the guest operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.vm_template_client module

+

The com.vmware.vcenter.vm_template_client module provides classes and +classes that will let its client manage VMTX template in Content Library.

+
+
+class com.vmware.vcenter.vm_template_client.LibraryItems(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LibraryItems class provides methods to deploy virtual machines from +library items containing virtual machine templates, as well as methods to +create library items containing virtual machine templates. The +LibraryItems class also provides an operation to retrieve information +about the template contained in the library item. This class was added in +vSphere API 6.8.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CpuInfo(count=None, cores_per_socket=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CpuInfo class contains CPU related information about +the virtual machine template. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • count (long) – Number of CPU cores. This attribute was added in vSphere API 6.8.

    • +

  • cores_per_socket (long) – Number of CPU cores per socket. This attribute was added in vSphere +API 6.8.

    • +
+
+
+
+ +
+
+class CpuUpdateSpec(num_cpus=None, num_cores_per_socket=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CpuUpdateSpec class describes updates to the CPU +configuration of the deployed virtual machine. This class was added in +vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • num_cpus (long or None) – Number of virtual processors in the deployed virtual machine. This +attribute was added in vSphere API 6.8. +If {\@term.unset}, the deployed virtual machine has the same CPU +count as the source virtual machine template contained in the +library item.

    • +

  • num_cores_per_socket (long or None) – Number of cores among which to distribute CPUs in the deployed +virtual machine. This attribute was added in vSphere API 6.8. +If {\@term.unset}, the deployed virtual machine has the same +number of cores per socket as the source virtual machine template +contained in the library item.

    • +
+
+
+
+ +
+
+class CreatePlacementSpec(folder=None, resource_pool=None, host=None, cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CreatePlacementSpec class contains information used to +place a virtual machine template onto resources within the vCenter +inventory. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine template +should be placed. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +If None, the virtual machine template will be placed in the same +folder as the source virtual machine.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine template should be +placed. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +If None, the system will attempt to choose a suitable resource pool +for the virtual machine template; if a resource pool cannot be +chosen, the library item creation operation will fail.

    • +

  • host (str or None) – Host onto which the virtual machine template should be placed. If +host and resourcePool are both specified, resourcePool +must belong to host. If host and cluster are both +specified, host must be a member of cluster. This attribute +was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute may be None if resourcePool or cluster is +specified. If None, the system will attempt to choose a suitable +host for the virtual machine template; if a host cannot be chosen, +the library item creation operation will fail.

    • +

  • cluster (str or None) – Cluster onto which the virtual machine template should be placed. +If cluster and resourcePool are both specified, +resourcePool must belong to cluster. If cluster and +host are both specified, host must be a member of +cluster. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    • +
+
+
+
+ +
+
+class CreateSpec(source_vm=None, name=None, description=None, library=None, vm_home_storage=None, disk_storage=None, disk_storage_overrides=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CreateSpec class defines the information required to +create a library item containing a virtual machine template. This class was +added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • source_vm (str) – Identifier of the source virtual machine to create the library item +from. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: VirtualMachine.

    • +

  • name (str) – Name of the library item. This attribute was added in vSphere API +6.8.

    • +

  • description (str or None) – Description of the library item. This attribute was added in +vSphere API 6.8. +If None, the newly created library item has the same description as +the source virtual machine.

    • +

  • library (str) – Identifier of the library in which the new library item should be +created. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

    • +

  • vm_home_storage (LibraryItems.CreateSpecVmHomeStorage or None) – Storage location for the virtual machine template’s configuration +and log files. This attribute was added in vSphere API 6.8. +If None, the virtual machine template’s configuration and log files +are placed on the default storage backing associated with the +library specified by library.

    • +

  • disk_storage (LibraryItems.CreateSpecDiskStorage or None) –

    Storage specification for the virtual machine template’s disks. +This attribute was added in vSphere API 6.8. +If both diskStorageOverrides and diskStorage are None, the +virtual machine template’s disks are placed in the default storage +backing associated with the library specified by library.

    +

    If diskStorageOverrides is None and diskStorage is +specified, all of the virtual machine template’s disks are created +with the storage spec specified by diskStorage.

    +

    If diskStorageOverrides is specified and diskStorage is +None, disks with identifiers that are not in +diskStorageOverrides are placed in the default storage backing +associated with the library specified by library.

    +

    If both diskStorageOverrides and diskStorage are specified, +disks with identifiers that are not in diskStorageOverrides are +created with the storage spec specified by diskStorage.

    +

    • +

  • disk_storage_overrides ((dict of str and LibraryItems.CreateSpecDiskStorage) or None) –

    Storage specification for individual disks in the virtual machine +template. This is specified as a mapping between disk identifiers +in the source virtual machine and their respective storage +specifications. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If both diskStorageOverrides and diskStorage are None, the +virtual machine template’s disks are placed in the default storage +backing associated with the library specified by library.

    +

    If diskStorageOverrides is None and diskStorage is +specified, all of the virtual machine template’s disks are created +with the storage spec specified by diskStorage.

    +

    If diskStorageOverrides is specified and diskStorage is +None, disks with identifiers that are not in +diskStorageOverrides are placed in the default storage backing +associated with the library specified by library.

    +

    If both diskStorageOverrides and diskStorage are specified, +disks with identifiers that are not in diskStorageOverrides are +created with the storage spec specified by diskStorage.

    +

    • +

  • placement (LibraryItems.CreatePlacementSpec or None) –

    Information used to place the virtual machine template. This +attribute was added in vSphere API 6.8. +This attribute is currently required. In the future, if this +attribute is None, the system will place the virtual machine +template on a suitable resource.

    +

    If specified, each attribute will be used for placement. If the +attributes result in disjoint placement, the operation will fail. +If the attributes along with the placement values of the source +virtual machine result in disjoint placement, the operation will +fail.

    +

    • +
+
+
+
+ +
+
+class CreateSpecDiskStorage(datastore=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CreateSpecDiskStorage class defines the storage +specification for a virtual machine template’s disks. This class was added +in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str or None) –

    Identifier for the datastore associated with a virtual machine +template’s disk. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required.

    +

    If storagePolicy is also specified and is incompatible with the +datastore, then the disk will be flagged as being out of +compliance with the specified storage policy.

    +

    • +

  • storage_policy (LibraryItems.CreateSpecDiskStoragePolicy or None) – Storage policy for a virtual machine template’s disk. This +attribute was added in vSphere API 6.8. +If None, datastore must be specified and the virtual machine +template’s disk is created with the default storage policy +associated with the datastore.

    • +
+
+
+
+ +
+
+class CreateSpecDiskStoragePolicy(type=None, policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CreateSpecDiskStoragePolicy class defines the storage +policy specification for a virtual machine template’s disks. This class was +added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LibraryItems.CreateSpecDiskStoragePolicy.Type) – Policy type to be used when creating a virtual machine template’s +disk. This attribute was added in vSphere API 6.8.

    • +

  • policy (str) – Identifier for the storage policy to use. This attribute was added +in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.spbm.StorageProfile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.spbm.StorageProfile. +This attribute is optional and it is only relevant when the value +of type is +LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Policy type for a virtual machine template’s disk. This enumeration was +added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')
+

Use the specified policy. This class attribute was added in vSphere API +6.8.

+
+ +
+ +
+ +
+
+class CreateSpecVmHomeStorage(datastore=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CreateSpecVmHomeStorage class defines the storage +specification for a virtual machine template’s configuration and log files. +This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str or None) –

    Identifier of the datastore for the virtual machine template’s +configuration and log files. This attribute was added in vSphere +API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required.

    +

    When storagePolicy is also specified and is incompatible with +the datastore, then the virtual machine template will be +flagged as being out of compliance with the specified storage +policy.

    +

    • +

  • storage_policy (LibraryItems.CreateSpecVmHomeStoragePolicy or None) – Storage policy for the virtual machine template’s configuration and +log files. This attribute was added in vSphere API 6.8. +If None, datastore must be specified and the virtual machine +template’s configuration and log files are created with the default +storage policy associated with the datastore.

    • +
+
+
+
+ +
+
+class CreateSpecVmHomeStoragePolicy(type=None, policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.CreateSpecVmHomeStoragePolicy class defines the +storage policy specification for a virtual machine template’s configuration +and log files. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LibraryItems.CreateSpecVmHomeStoragePolicy.Type) – Policy type to be used when creating the virtual machine template’s +configuration and log files. This attribute was added in vSphere +API 6.8.

    • +

  • policy (str) – Identifier for the storage policy to use. This attribute was added +in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.spbm.StorageProfile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.spbm.StorageProfile. +This attribute is optional and it is only relevant when the value +of type is +LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Policy type for the virtual machine template’s configuration and log files. +This enumeration was added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')
+

Use the specified policy. This class attribute was added in vSphere API +6.8.

+
+ +
+ +
+ +
+
+class DeployPlacementSpec(folder=None, resource_pool=None, host=None, cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DeployPlacementSpec class contains information used to +place a virtual machine onto resources within the vCenter inventory. This +class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) –

    Virtual machine folder into which the deployed virtual machine +should be placed. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +This attribute is currently required.

    +

    If None, the system will attempt to choose a suitable folder for +the virtual machine; if a folder cannot be chosen, the virtual +machine deployment operation will fail.

    +

    • +

  • resource_pool (str or None) – Resource pool into which the deployed virtual machine should be +placed. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +If None, the system will attempt to choose a suitable resource pool +for the virtual machine; if a resource pool cannot be chosen, the +virtual machine deployment operation will fail.

    • +

  • host (str or None) – Host onto which the virtual machine should be placed. If host +and resourcePool are both specified, resourcePool must +belong to host. If host and cluster are both specified, +host must be a member of cluster. This attribute was added +in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute may be None if resourcePool or cluster is +specified. If None, the system will attempt to choose a suitable +host for the virtual machine; if a host cannot be chosen, the +virtual machine deployment operation will fail.

    • +

  • cluster (str or None) – Cluster onto which the deployed virtual machine should be placed. +If cluster and resourcePool are both specified, +resourcePool must belong to cluster. If cluster and +host are both specified, host must be a member of +cluster. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    • +
+
+
+
+ +
+
+class DeploySpec(name=None, description=None, vm_home_storage=None, disk_storage=None, disk_storage_overrides=None, placement=None, powered_on=None, guest_customization=None, hardware_customization=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DeploySpec class defines the deployment parameters +that can be specified for the deploy method. This class was added in +vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the deployed virtual machine. This attribute was added in +vSphere API 6.8.

    • +

  • description (str or None) – Description of the deployed virtual machine. This attribute was +added in vSphere API 6.8. +If None, the deployed virtual machine has the same description as +the source library item.

    • +

  • vm_home_storage (LibraryItems.DeploySpecVmHomeStorage or None) – Storage location for the deployed virtual machine’s configuration +and log files. This attribute was added in vSphere API 6.8. +If None, the deployed virtual machine’s configuration and log files +are created with the same storage spec as the source virtual +machine template’s configuration and log files.

    • +

  • disk_storage (LibraryItems.DeploySpecDiskStorage or None) –

    Storage specification for the deployed virtual machine’s disks. +This attribute was added in vSphere API 6.8. +If both diskStorageOverrides and diskStorage are None, the +deployed virtual machine’s disks are created with the same storage +spec as the corresponding disks in the source virtual machine +template contained in the library item.

    +

    If diskStorageOverrides is None and diskStorage is +specified, all of the deployed virtual machine’s disks are created +with the storage spec specified by diskStorage.

    +

    If diskStorageOverrides is specified and diskStorage is +None, disks with identifiers that are not in +diskStorageOverrides are created with the same storage spec as +the corresponding disks in the source virtual machine template +contained in the library item.

    +

    If both diskStorageOverrides and diskStorage are specified, +disks with identifiers that are not in diskStorageOverrides are +created with the storage spec specified by diskStorage.

    +

    • +

  • disk_storage_overrides ((dict of str and LibraryItems.DeploySpecDiskStorage) or None) –

    Storage specification for individual disks in the deployed virtual +machine. This is specified as a mapping between disk identifiers in +the source virtual machine template contained in the library item +and their storage specifications. This attribute was added in +vSphere API 6.8. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If both diskStorageOverrides and diskStorage are None, the +deployed virtual machine’s disks are created with the same storage +spec as the corresponding disks in the source virtual machine +template contained in the library item.

    +

    If diskStorageOverrides is None and diskStorage is +specified, all of the deployed virtual machine’s disks are created +with the storage spec specified by diskStorage.

    +

    If diskStorageOverrides is specified and diskStorage is +None, disks with identifiers that are not in +diskStorageOverrides are created with the same storage spec as +the corresponding disks in the source virtual machine template +contained in the library item.

    +

    If both diskStorageOverrides and diskStorage are specified, +disks with identifiers that are not in diskStorageOverrides are +created with the storage spec specified by diskStorage.

    +

    • +

  • placement (LibraryItems.DeployPlacementSpec or None) –

    Information used to place the deployed virtual machine. This +attribute was added in vSphere API 6.8. +This attribute is currently required. In the future, if this +attribute is None, the system will use the values from the source +virtual machine template contained in the library item.

    +

    If specified, each attribute will be used for placement. If the +attributes result in disjoint placement, the operation will fail. +If the attributes along with the placement values of the source +virtual machine template result in disjoint placement, the +operation will fail.

    +

    • +

  • powered_on (bool or None) – Specifies whether the deployed virtual machine should be powered on +after deployment. This attribute was added in vSphere API 6.8. +If None, the virtual machine will not be powered on after +deployment.

    • +

  • guest_customization (LibraryItems.GuestCustomizationSpec or None) – Guest customization spec to apply to the deployed virtual machine. +This attribute was added in vSphere API 6.8. +If None, the guest operating system is not customized after +deployment.

    • +

  • hardware_customization (LibraryItems.HardwareCustomizationSpec or None) – Hardware customization spec which specifies updates to the deployed +virtual machine. This attribute was added in vSphere API 6.8. +If None, the deployed virtual machine has the same hardware +configuration as the source virtual machine template contained in +the library item.

    • +
+
+
+
+ +
+
+class DeploySpecDiskStorage(datastore=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DeploySpecDiskStorage class contains the storage +specification for disks in the virtual machine. This class was added in +vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str or None) –

    Identifier for the datastore associated the deployed virtual +machine’s disk. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required.

    +

    If storagePolicy is also specified and is incompatible with the +datastore, then the disk will be flagged as being out of +compliance with the specified storage policy.

    +

    • +

  • storage_policy (LibraryItems.DeploySpecDiskStoragePolicy or None) – Storage policy for the deployed virtual machine’s disk. This +attribute was added in vSphere API 6.8. +If None, datastore must be specified and the deployed virtual +machine’s disk is created with the default storage policy +associated with the datastore.

    • +
+
+
+
+ +
+
+class DeploySpecDiskStoragePolicy(type=None, policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DeploySpecDiskStoragePolicy class describes the +storage policy specification for the deployed virtual machine’s disks. This +class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LibraryItems.DeploySpecDiskStoragePolicy.Type) – Policy type to be used when creating the deployed virtual machine’s +disk. This attribute was added in vSphere API 6.8.

    • +

  • policy (str) – Identifier of the storage policy to use. This attribute was added +in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.spbm.StorageProfile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.spbm.StorageProfile. +This attribute is optional and it is only relevant when the value +of type is +LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Policy type for the deployed virtual machine’s disk. This enumeration was +added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+USE_SOURCE_POLICY = Type(string='USE_SOURCE_POLICY')
+

Use the storage policy that is associated with the corresponding disk in +the source virtual machine template. This class attribute was added in +vSphere API 6.8.

+
+ +
+
+USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')
+

Use the specified policy. This class attribute was added in vSphere API +6.8.

+
+ +
+ +
+ +
+
+class DeploySpecVmHomeStorage(datastore=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DeploySpecVmHomeStorage class defines the storage +specification for a deployed virtual machine’s configuration and log files. +This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str or None) –

    Identifier of the datastore for the deployed virtual machine’s +configuration and log files. This attribute was added in vSphere +API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore. +This attribute is currently required.

    +

    When storagePolicy is also specified and is incompatible with +the datastore, then the deployed virtual machine will be +flagged as being out of compliance with the specified storage +policy.

    +

    • +

  • storage_policy (LibraryItems.DeploySpecVmHomeStoragePolicy or None) – Storage policy for the deployed virtual machine’s configuration and +log files. This attribute was added in vSphere API 6.8. +If None, datastore must be specified and the deployed virtual +machine’s configuration and log files are created with the default +storage policy associated with the datastore.

    • +
+
+
+
+ +
+
+class DeploySpecVmHomeStoragePolicy(type=None, policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DeploySpecVmHomeStoragePolicy class defines the +storage policy specification for the deployed virtual machine’s +configuration and log files. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (LibraryItems.DeploySpecVmHomeStoragePolicy.Type) – Policy type to be used when creating the deployed virtual machine’s +configuration and log files. This attribute was added in vSphere +API 6.8.

    • +

  • policy (str) – Identifier for the storage policy to use. This attribute was added +in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.spbm.StorageProfile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.spbm.StorageProfile. +This attribute is optional and it is only relevant when the value +of type is +LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Policy type for the deployed virtual machine’s configuration and log files. +This enumeration was added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+USE_SOURCE_POLICY = Type(string='USE_SOURCE_POLICY')
+

Use the storage policy that is associated with the source virtual machine +template’s configuration and log files. This class attribute was added in +vSphere API 6.8.

+
+ +
+
+USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')
+

Use the specified policy. This class attribute was added in vSphere API +6.8.

+
+ +
+ +
+ +
+
+class DiskInfo(capacity=None, disk_storage=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DiskInfo class contains information about the virtual +machine template’s virtual disk. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • capacity (long or None) – Capacity of the virtual disk in bytes. This attribute was added in +vSphere API 6.8. +This attribute will be None if the virtual disk is inaccessible.

    • +

  • disk_storage (LibraryItems.DiskStorageInfo) – Disk storage related information. This attribute was added in +vSphere API 6.8.

    • +
+
+
+
+ +
+
+class DiskStorageInfo(datastore=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DiskStorageInfo class contains storage related +information about a virtual machine template’s virtual disk. This class was +added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str) – Identifier of the datastore where the disk is stored. This +attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore.

    • +

  • storage_policy (str or None) – Identifier of the storage policy associated with the virtual disk. +This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.spbm.StorageProfile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.spbm.StorageProfile. +If None, the virtual disk does not have a storage policy associated +with it.

    • +
+
+
+
+ +
+
+class DiskUpdateSpec(capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.DiskUpdateSpec class describes updates to the +configuration of a virtual disk in the deployed virtual machine. This class +was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

capacity (long) – Updated capacity of the virtual disk backing in bytes. This value +has to be larger than the original capacity of the disk. This +attribute was added in vSphere API 6.8.

+
+
+
+ +
+
+class EthernetInfo(backing_type=None, mac_type=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.EthernetInfo class contains information about a +virtual machine template’s virtual Ethernet adapter. This class was added +in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing_type (LibraryItems.EthernetInfo.NetworkBackingType) – Network backing type for the virtual Ethernet adapter. This +attribute was added in vSphere API 6.8.

    • +

  • mac_type (LibraryItems.EthernetInfo.MacAddressType) – MAC address type of the ethernet adapter. This attribute was added +in vSphere API 6.8.

    • +

  • network (str or None) – Identifier of the network backing the virtual Ethernet adapter. +This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network. +This attribute will be None if the identifier of the network +backing could not be determined.

    • +
+
+
+
+
+class MacAddressType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LibraryItems.EthernetInfo.MacAddressType class defines the valid +MAC address origins for a virtual Ethernet adapter. This enumeration was +added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MacAddressType instance.

+
+
+
+
+ASSIGNED = MacAddressType(string='ASSIGNED')
+

MAC address is assigned by vCenter Server. This class attribute was added +in vSphere API 6.8.

+
+ +
+
+GENERATED = MacAddressType(string='GENERATED')
+

MAC address is generated automatically. This class attribute was added in +vSphere API 6.8.

+
+ +
+
+MANUAL = MacAddressType(string='MANUAL')
+

MAC address is assigned statically. This class attribute was added in +vSphere API 6.8.

+
+ +
+ +
+
+class NetworkBackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LibraryItems.EthernetInfo.NetworkBackingType class defines valid +network backing types for a virtual Ethernet adapter. This enumeration was +added in vSphere API 6.8.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkBackingType instance.

+
+
+
+
+DISTRIBUTED_PORTGROUP = NetworkBackingType(string='DISTRIBUTED_PORTGROUP')
+

Distributed virtual switch backing. This class attribute was added in +vSphere API 6.8.

+
+ +
+
+HOST_DEVICE = NetworkBackingType(string='HOST_DEVICE')
+

Legacy host device network backing. Imported VMs may have virtual Ethernet +adapters with this type of backing, but this type of backing cannot be used +to create or to update a virtual Ethernet adapter. This class attribute was +added in vSphere API 6.8.

+
+ +
+
+OPAQUE_NETWORK = NetworkBackingType(string='OPAQUE_NETWORK')
+

Opaque network backing. This class attribute was added in vSphere API 6.8.

+
+ +
+
+STANDARD_PORTGROUP = NetworkBackingType(string='STANDARD_PORTGROUP')
+

vSphere standard portgroup network backing. This class attribute was added +in vSphere API 6.8.

+
+ +
+ +
+ +
+
+class EthernetUpdateSpec(network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.EthernetUpdateSpec class describes the network that +the ethernet adapter of the deployed virtual machine should be connected +to. This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

network (str or None) –

Identifier of the network backing the virtual Ethernet adapter. +This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network. +This attribute is currently required.

+

If None, the virtual Ethernet adapter will be connected to same +network as it was in the source virtual machine template.

+

+
+
+
+ +
+
+class GuestCustomizationSpec(name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.GuestCustomizationSpec class contains information +required to customize the deployed virtual machine. This class was added in +vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

name (str or None) – Name of the customization specification. This attribute was added +in vSphere API 6.8. +If None, no guest customization is performed.

+
+
+
+ +
+
+class HardwareCustomizationSpec(nics=None, disks_to_remove=None, disks_to_update=None, cpu_update=None, memory_update=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.HardwareCustomizationSpec class defines the hardware +customization options that are applied to the deployed virtual machine. +This class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • nics ((dict of str and LibraryItems.EthernetUpdateSpec) or None) – Map of Ethernet network adapters to update. This attribute was +added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet. +If None, all Ethernet adapters will remain connected to the same +network as they were in the source virtual machine template. An +Ethernet adapter with a MacAddressType of MANUAL will not change. +An Ethernet adapter with a MacAddressType of GENERATED or ASSIGNED +will receive a new address.

    • +

  • disks_to_remove (set of str or None) – Idenfiers of disks to remove from the deployed virtual machine. +This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None, all disks will be copied.

    • +

  • disks_to_update ((dict of str and LibraryItems.DiskUpdateSpec) or None) – Disk update specification for individual disks in the deployed +virtual machine. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None, disks in the deployed virtual machine will have the same +settings as the corresponding disks in the source virtual machine +template contained in the library item.

    • +

  • cpu_update (LibraryItems.CpuUpdateSpec or None) – CPU update specification for the deployed virtual machine. This +attribute was added in vSphere API 6.8. +If {\@term.unset}, the deployed virtual machine has the same CPU +settings as the source virtual machine template contained in the +library item.

    • +

  • memory_update (LibraryItems.MemoryUpdateSpec or None) – Memory update specification for the deployed virtual machine. This +attribute was added in vSphere API 6.8. +If {\@term.unset}, the deployed virtual machine has the same +memory settings as the source virtual machine template contained in +the library item.

    • +
+
+
+
+ +
+
+class Info(guest_os=None, cpu=None, memory=None, vm_home_storage=None, disks=None, nics=None, vm_template=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.Info class contains information about a virtual +machine template item in content library. This class was added in vSphere +API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • guest_os (com.vmware.vcenter.vm_client.GuestOS) – Configured guest operating system of the virtual machine template. +This attribute was added in vSphere API 6.8.

    • +

  • cpu (LibraryItems.CpuInfo) – CPU configuration of the virtual machine template. This attribute +was added in vSphere API 6.8.

    • +

  • memory (LibraryItems.MemoryInfo) – Memory configuration of the virtual machine template. This +attribute was added in vSphere API 6.8.

    • +

  • vm_home_storage (LibraryItems.VmHomeStorageInfo) – Storage information about the virtual machine template’s +configuration and log files. This attribute was added in vSphere +API 6.8.

    • +

  • disks (dict of str and LibraryItems.DiskInfo) – Storage information about the virtual machine template’s virtual +disks. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +

  • nics (dict of str and LibraryItems.EthernetInfo) – Information about the virtual machine template’s virtual ethernet +adapters. This attribute was added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet. When methods +return a value of this class as a return value, the key in the +attribute dict will be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Ethernet.

    • +

  • vm_template (str) – Identifier of the latest virtual machine template contained in the +library item. This attribute is the managed object identifier used +to identify the virtual machine template in the vSphere Management +(SOAP) API. This attribute was added in vSphere API 6.8.

    • +
+
+
+
+ +
+
+class MemoryInfo(size_mib=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.MemoryInfo class contains memory related information +about the virtual machine template. This class was added in vSphere API +6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

size_mib (long) – Memory size in mebibytes. This attribute was added in vSphere API +6.8.

+
+
+
+ +
+
+class MemoryUpdateSpec(memory=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.MemoryUpdateSpec class describes updates to the memory +configuration of the deployed virtual machine. This class was added in +vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

memory (long or None) – Size of a virtual machine’s memory in MB. This attribute was added +in vSphere API 6.8. +If {\@term.unset}, the deployed virtual machine has the same +memory size as the source virtual machine template.

+
+
+
+ +
+
+class VmHomeStorageInfo(datastore=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LibraryItems.VmHomeStorageInfo class contains storage information +about the virtual machine template’s configuration and log files. This +class was added in vSphere API 6.8.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • datastore (str) – Identifier of the datastore where the virtual machine template’s +configuration and log files are stored. This attribute was added in +vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: Datastore.

    • +

  • storage_policy (str or None) – Identifier of the storage policy associated with the virtual +machine template’s configuration and log files. This attribute was +added in vSphere API 6.8. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.spbm.StorageProfile. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.spbm.StorageProfile. +If None, the virtual machine template’s configuration and log files +do not have a storage policy associated with them.

    • +
+
+
+
+ +
+
+create(spec)
+

Creates a library item in content library from a virtual machine. This +method creates a library item in content library whose content is a +virtual machine template created from the source virtual machine, using +the supplied create specification. The virtual machine template is +stored in a newly created library item. This method was added in +vSphere API 6.8.

+
+
Parameters
+

spec (LibraryItems.CreateSpec) – information used to create the library item from the source virtual +machine.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly created library item. +The return value will be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if an entity with the name specified by +LibraryItems.CreateSpec.name already exists in the folder +specified by LibraryItems.CreatePlacementSpec.folder.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if LibraryItems.CreateSpec contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the operation cannot be performed because of the source virtual +machine’s current state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the source virtual machine specified by +LibraryItems.CreateSpec.source_vm does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library specified by LibraryItems.CreateSpec.library +does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there was an error accessing a file from the source virtual +machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the source virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if any of the services involved in the method are unavailable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if any of the resources needed to create the virtual machine +template could not be allocated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.Library referenced by the +attribute LibraryItems.CreateSpec.library requires +ContentLibrary.AddLibraryItem.

    • +

  • The resource VirtualMachine referenced by the attribute +LibraryItems.CreateSpec.source_vm requires System.Read.

    • +

  • The resource Datastore referenced by the attribute +LibraryItems.CreateSpecVmHomeStorage.datastore requires +System.Read.

    • +

  • The resource com.vmware.spbm.StorageProfile referenced by the +attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy +requires System.Read.

    • +

  • The resource Datastore referenced by the attribute +LibraryItems.CreateSpecDiskStorage.datastore requires +System.Read.

    • +

  • The resource com.vmware.spbm.StorageProfile referenced by the +attribute LibraryItems.CreateSpecDiskStoragePolicy.policy +requires System.Read.

    • +

  • The resource com.vmware.vcenter.vm.hardware.Disk referenced +by the dict key of attribute +LibraryItems.CreateSpec.disk_storage_overrides requires +System.Read.

    • +

  • The resource Folder referenced by the attribute +LibraryItems.CreatePlacementSpec.folder requires +System.Read.

    • +

  • The resource ResourcePool referenced by the attribute +LibraryItems.CreatePlacementSpec.resource_pool requires +System.Read.

    • +

  • The resource HostSystem referenced by the attribute +LibraryItems.CreatePlacementSpec.host requires +System.Read.

    • +

  • The resource ClusterComputeResource referenced by the +attribute LibraryItems.CreatePlacementSpec.cluster requires +System.Read.

    • +
+
+
+
+ +
+
+deploy(template_library_item, spec)
+

Deploys a virtual machine as a copy of the source virtual machine +template contained in the library item specified by +template_library_item. It uses the deployment specification in +spec. If LibraryItems.DeploySpec.powered_on and/or +LibraryItems.DeploySpec.guest_customization are specified, the +server triggers the power on and/or guest customization operations, +which are executed asynchronously. This method was added in vSphere API +6.8.

+
+
Parameters
+
    +

  • template_library_item (str) – identifier of the content library item containing the source +virtual machine template to be deployed. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • spec (LibraryItems.DeploySpec) – specification of how the virtual machine should be deployed.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the deployed virtual machine. +The return value will be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the name specified by +LibraryItems.DeploySpec.name already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if either a specified host or a specified datastore is in an +invalid state for the deployment, such as maintenance mode.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by template_library_item cannot +be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if any resource specified by a attribute of the +LibraryItems.DeploySpec class, specified by spec +cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there was an error accessing the source virtual machine template +contained in the library item specified by +template_library_item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there an error accessing any of the resources specified in the +spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if any of the services involved in the method are unavailable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if there was an error in allocating any of the resources required +by the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires +VirtualMachine.Provisioning.DeployTemplate.

    • +

  • The resource Datastore referenced by the attribute +LibraryItems.DeploySpecVmHomeStorage.datastore requires +System.Read.

    • +

  • The resource com.vmware.spbm.StorageProfile referenced by the +attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy +requires System.Read.

    • +

  • The resource Datastore referenced by the attribute +LibraryItems.DeploySpecDiskStorage.datastore requires +System.Read.

    • +

  • The resource com.vmware.spbm.StorageProfile referenced by the +attribute LibraryItems.DeploySpecDiskStoragePolicy.policy +requires System.Read.

    • +

  • The resource com.vmware.vcenter.vm.hardware.Disk referenced +by the dict key of attribute +LibraryItems.DeploySpec.disk_storage_overrides requires +System.Read.

    • +

  • The resource Folder referenced by the attribute +LibraryItems.DeployPlacementSpec.folder requires +System.Read.

    • +

  • The resource ResourcePool referenced by the attribute +LibraryItems.DeployPlacementSpec.resource_pool requires +System.Read.

    • +

  • The resource HostSystem referenced by the attribute +LibraryItems.DeployPlacementSpec.host requires +System.Read.

    • +

  • The resource ClusterComputeResource referenced by the +attribute LibraryItems.DeployPlacementSpec.cluster requires +System.Read.

    • +

  • The resource com.vmware.vcenter.vm.hardware.Ethernet +referenced by the dict key of attribute +LibraryItems.HardwareCustomizationSpec.nics requires +System.Read.

    • +

  • The resource Network referenced by the attribute +LibraryItems.EthernetUpdateSpec.network requires +System.Read.

    • +

  • The resource com.vmware.vcenter.vm.hardware.Disk referenced +by the attribute +LibraryItems.HardwareCustomizationSpec.disks_to_remove +requires System.Read.

    • +

  • The resource com.vmware.vcenter.vm.hardware.Disk referenced +by the dict key of attribute +LibraryItems.HardwareCustomizationSpec.disks_to_update +requires System.Read.

    • +
+
+
+
+ +
+
+get(template_library_item)
+

Returns information about a virtual machine template contained in the +library item specified by template_library_item. This method was +added in vSphere API 6.8.

+
+
Parameters
+

template_library_item (str) – identifier of the library item containing the virtual machine +template. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

LibraryItems.Info or None

+
+
Returns
+

Information about the virtual machine template item contained in +the library item. +If None, the library item specified by template_library_item +does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item could not be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine template’s configuration state cannot be +accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if any of the services involved in the method are unavailable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_template_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.hvc.html b/vsphere/8.0.2.0/com.vmware.vcenter.hvc.html new file mode 100644 index 00000000..7c2427b4 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.hvc.html @@ -0,0 +1,245 @@ + + + + + + + com.vmware.vcenter.hvc package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.hvc package

+
+

Submodules

+
+
+

com.vmware.vcenter.hvc.management_client module

+
+
+class com.vmware.vcenter.hvc.management_client.Administrators(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Administrators provides methods to update, delete, and list groups +in the local sso group. This is limited to the Hybrid Linked Mode service. +Usage beyond VMware Cloud on AWS is not supported.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+add(group_name)
+

Add the local sso group with the new group. Usage beyond VMware Cloud +on AWS is not supported.

+
+
Parameters
+

group_name (str) – Name of the new group to be added. Ex - xyz\@abc.com where xyz +is the group name and abc.com is the domain name

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+
+get()
+

Enumerates the set of all the groups in the local sso group. Usage +beyond VMware Cloud on AWS is not supported.

+
+
Return type
+

set of str

+
+
Returns
+

The set of all the groups.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+
+remove(group_name)
+

Remove the group from the local sso group. Usage beyond VMware Cloud on +AWS is not supported.

+
+
Parameters
+

group_name (str) – Name of the group to be removed. Ex - xyz\@abc.com where xyz is +the group name and abc.com is the domain name

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+
+set(group_names)
+

Sets the groups in the local sso group. Usage beyond VMware Cloud on +AWS is not supported.

+
+
Parameters
+

group_names (set of str) – Names the groups to be in the CloudAdminGroup Ex - xyz\@abc.com +where xyz is the group name and abc.com is the domain name

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.hvc.management_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.identity.broker.html b/vsphere/8.0.2.0/com.vmware.vcenter.identity.broker.html new file mode 100644 index 00000000..0ea61419 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.identity.broker.html @@ -0,0 +1,315 @@ + + + + + + + com.vmware.vcenter.identity.broker package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.identity.broker package

+
+

Submodules

+
+
+

com.vmware.vcenter.identity.broker.tenants_client module

+

The com.vmware.vcenter.identity.broker.tenants_client module provides +classes to manage external authentication broker tenant data.

+
+
+class com.vmware.vcenter.identity.broker.tenants_client.AdminClient(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AdminClient interface provides methods to read the token info of +tenant admin client. The tenant client belongs to the pre-configured +tenant(s), that were created at bootstrap of vcenter trustmanagement +service. The tenant admin client tokens can be used to perform API +invocations within a tenant entity. This class was added in vSphere API +8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(tenant)
+

Returns the tenant admin client token info associated with +pre-configured tenant(s) owned by vcenter trustmanagment service. This +method was added in vSphere API 8.0.1.0.

+
+
Parameters
+

tenant (str) – The tenant name for which the admin client token needs to be +returned. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.identity.broker.tenant.

+
+
Return type
+

TokenInfo

+
+
Returns
+

TokenInfo class that contains a newly issued tenant admin +client token.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no tenant owned by vcenter trustmanagment service, with the +input parameter found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if not authorized to invoke the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.identity.broker.tenants_client.OperatorClient(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The OperatorClient interface provides methods to read the token info of +operator client. The operator client belongs to the pre-configured HWS +tenant, that was created at bootstrap/installation of broker. The operator +client tokens can be used to call the tenant management APIs like create, +get and delete of tenant entity. This class was added in vSphere API +8.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get()
+

Return the operator client token info in Broker. The operator client +was created at bootstrap or installation of broker. This token can be +used to manage tenant entity APIs. This method was added in vSphere API +8.0.1.0.

+
+
Return type
+

TokenInfo

+
+
Returns
+

TokenInfo class that contains a newly issued operator +client token.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if any other error occurs.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no operator client details found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if not authorized to invoke the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires VcIdentityProviders.Manage.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.identity.broker.tenants_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.identity.broker.tenants_client.TokenInfo(token_type=None, access_token=None, expires_in=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TokenInfo class contains detailed information about the tenant +token. This class was added in vSphere API 8.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • token_type (str) –

    The type of the token issued. The access token type provides the +client with the information required to successfully utilize the +access token to make a protected resource request (along with +type-specific attributes). The client MUST NOT use an access token +if it does not understand the token type.

    +

    ”Bearer” token type as defined in RFC 6750 is supported.. This +attribute was added in vSphere API 8.0.1.0.

    +

    • +

  • access_token (str) – Tenant client access token issued by the authorization server. This +attribute was added in vSphere API 8.0.1.0.

    • +

  • expires_in (long or None) – The lifetime in seconds of the access token. For example, the value +“3600” denotes that the access token will expire in one hour from +the time the response was generated. This attribute was added in +vSphere API 8.0.1.0. +None if not applicable for issued token.

    • +
+
+
+
+
+BEARER_TOKEN_METHOD_TYPE = 'Bearer'
+

Class attribute indicating that the security token is a bearer token. This +class attribute was added in vSphere API 8.0.1.0.

+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.identity.html b/vsphere/8.0.2.0/com.vmware.vcenter.identity.html new file mode 100644 index 00000000..2209fd30 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.identity.html @@ -0,0 +1,163 @@ + + + + + + + com.vmware.vcenter.identity package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.identity package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.identity.broker_client module

+

The com.vmware.vcenter.identity.broker_client module provides classes to +manage external authentication broker data.

+
+
+class com.vmware.vcenter.identity.broker_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.lcm.deployment.html b/vsphere/8.0.2.0/com.vmware.vcenter.lcm.deployment.html new file mode 100644 index 00000000..e179d788 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.lcm.deployment.html @@ -0,0 +1,216 @@ + + + + + + + com.vmware.vcenter.lcm.deployment package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.lcm.deployment package

+
+

Submodules

+
+
+

com.vmware.vcenter.lcm.deployment.common_client module

+

The com.vmware.vcenter.deployment.common module provides common classes for +install/upgrade of a vCenter Server.

+
+
+class com.vmware.vcenter.lcm.deployment.common_client.AllocateResource(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The AllocateResource class defines when to allocate resource to VM. +This enumeration was added in vSphere API 8.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the AllocateResource instance.

+
+
+
+
+ON_DEPLOYMENT = AllocateResource(string='ON_DEPLOYMENT')
+

On deployment of the VM allocate the resource to the target VM. This class +attribute was added in vSphere API 8.0.2.0.

+
+ +
+
+ON_SUCCESSFUL_UPGRADE = AllocateResource(string='ON_SUCCESSFUL_UPGRADE')
+

On successful upgrade of the VC allocate the resource to the target VM. +This class attribute was added in vSphere API 8.0.2.0.

+
+ +
+ +
+
+class com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo(reservation=None, allocate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ResourceAllocationInfo class contains resource allocation +information of VM. This class was added in vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reservation (long) – Amount of resource that is guaranteed available to the virtual +machine. Reserved resources are not wasted if they are not used. If +the utilization is less than the reservation, the resources can be +utilized by other running virtual machines. Units are MB for +memory, and MHz for CPU. This attribute was added in vSphere API +8.0.2.0.

    • +

  • allocate (AllocateResource or None) – This attribute was added in vSphere API 8.0.2.0. +If None will allocate resource at VM deployment.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.lcm.deployment.common_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.lcm.html b/vsphere/8.0.2.0/com.vmware.vcenter.lcm.html new file mode 100644 index 00000000..bfc349ca --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.lcm.html @@ -0,0 +1,1186 @@ + + + + + + + com.vmware.vcenter.lcm package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.lcm package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.lcm.deployment_client module

+

The com.vmware.vcenter.deployment module provides classes for the upgrade +and deployment needs of a vCSA. Copyright 2023 VMware, Inc. All rights +reserved. – VMware Confidential Copyright 2022 VMware, Inc. All rights +reserved. – VMware Confidential Copyright 2022 VMware, Inc. All rights +reserved. – VMware Confidential Copyright 2022 VMware, Inc. All rights +reserved. – VMware Confidential

+
+
+class com.vmware.vcenter.lcm.deployment_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.lcm.discovery_client module

+

The com.vmware.vcenter.lcm.discovery_client module provides classes for +discovering products registered with vCenter Server and interoperability +between those products and vCenter Server.

+
+
+class com.vmware.vcenter.lcm.discovery_client.AssociatedProducts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The AssociatedProducts class provides options to list, add, modify, and +delete VMware products associated with vCenter Server. Some products can be +auto-detected by the system while others can be added manually.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(product_name=None, version=None, deployments=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AssociatedProducts.CreateSpec class is the specification used for +the product creation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • product_name (str) – The name of the product.

    • +

  • version (str) – Current product version.

    • +

  • deployments (list of str or None) – The list of hostname/IPs of the instances of the VMware products +deployed in the environment.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.lcm.product'
+

The resource type for the products interface.

+
+ +
+
+class UpdateSpec(deployments=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The AssociatedProducts.UpdateSpec class is the specification for the +product update.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

deployments (list of str or None) – The list of hostname/IPs of the instances of the VMware products +deployed in the environment.

+
+
+
+ +
+
+create(spec)
+

Associates a VMware product with vCenter Server manually. The product +must be taken from the product catalog API.

+
+
Parameters
+

spec (AssociatedProducts.CreateSpec) – Info creation specification.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the newly-added product. +The return value will be an identifier for the resource type: +com.vmware.vcenter.lcm.product.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if this version is already added

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the spec argument is not allowed

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+
+delete(product)
+

Deletes or dissociates a VMware product associated with vCenter Server +which was added manually. Automatically discovered VMware products +cannot be deleted or dissociated.

+
+
Parameters
+

product (str) – An id of the product to be removed. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.lcm.product.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no record associated with product in the system +database.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+
+get(product)
+

Returns the detailed information of a product associated with vCenter +Server.

+
+
Parameters
+

product (str) – An identifier of the product to be modified. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.lcm.product.

+
+
Return type
+

Product

+
+
Returns
+

Product details.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no record associated with product in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+
+list()
+

Retrieves a list of all associated VMware product deployments with +vCenter Server in the environment. The list contains both product +deployments discovered automatically and deployments registered +manually through the API.

+
+
Return type
+

list of Product

+
+
Returns
+

List of all the registered products with vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+
+update(product, spec)
+

Modifies a VMware product associated with vCenter Server which was +added manually. Automatically discovered VMware products cannot be +modified.

+
+
Parameters
+
    +

  • product (str) – An id of the product to be modified. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.lcm.product.

    • +

  • spec (AssociatedProducts.UpdateSpec) –

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the spec argument is not allowed

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If there is no record associated with product in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.lcm.discovery_client.InteropReport(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The InteropReport interface provides methods to report the +interoperability between a vCenter Server release version and the other +installed VMware products registered in the vCenter Server instance.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ReleaseInfo(version=None, note=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InteropReport.ReleaseInfo class contains a product release +information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – The version of the release.

    • +

  • note (str or None) – A link to the release notes of the release. +None if the release notes are not available.

    • +
+
+
+
+ +
+
+class Report(date_created=None, target_product=None, products=None, issues=None, summary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InteropReport.Report class contains the interoperability report +between the target product and the other registered products in the vCenter +Server instance.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • date_created (datetime.datetime) – Time when the report is created.

    • +

  • target_product (Product) – A product against the other products are compared to. Only vCenter +Server is supported.

    • +

  • products (list of InteropReport.ReportRow) – Interoperability matrix for the supplied target product and the +other registered products.

    • +

  • issues (com.vmware.vcenter.lcm_client.Notifications or None) – Lists of issues encountered during report creation. +set if any issues encountered.

    • +

  • summary (InteropReport.ReportSummary) – A summary of the interoperability matrix.

    • +
+
+
+
+ +
+
+class ReportRow(product=None, compatible=None, compatible_releases=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InteropReport.ReportRow class contains the interoperability between +a given product and the target product.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • product (Product) – The product to compare to the target product.

    • +

  • compatible (bool) – Defines whether the product is compatible against the target +product.

    • +

  • compatible_releases (list of InteropReport.ReleaseInfo) – A list of compatible releases of the product with the target +product.

    • +
+
+
+
+ +
+
+class ReportSummary(compatible_count=None, incompatible_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InteropReport.ReportSummary class contains a summary of the +InteropReport.Report.products. It consists of the count of +compatible and incompatible products to the target product.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatible_count (long) – Number of compatible products.

    • +

  • incompatible_count (long) – Number of incompatible products.

    • +
+
+
+
+ +
+
+class Result(report=None, csv_report=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The InteropReport.Result class contains the result of interoperability +report creation operation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • report (InteropReport.Report) – The interoperability report.

    • +

  • csv_report (str or None) –

    The identifier of CSV formatted interopability report.

    +

    com.vmware.vcenter.lcm.report.Report#get provides location where +the CSV report can be downloaded from based on the csvReport. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.lcm.report. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.lcm.report. +None in case of errors reported in +InteropReport.Report.issues.

    +

    • +
+
+
+
+ +
+
+class Spec(target_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Configuration of report generation.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

target_version (str) –

The vCenter Server version.

+

It is used for checking against the other products registered with +that instance of vCenter Server.

+

+
+
+
+ +
+
+create_task(spec=None)
+

Creates interoperability report between a vCenter Server release +version and all registered products with the vCenter Server instance.

+

The result of this operation can be queried by calling the +com.vmware.cis.Tasks#get method where task is the response of this +operation.

+
+
Parameters
+

spec (InteropReport.Spec or None) – Specifies the target version against this interoperability check +report will be generated. If None the report will be generated for +the currently installed version of the vCenter server.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.lcm.discovery_client.Product(installed_product=None, name=None, version=None, target_version=None, deployments=None, auto=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Info class contains information about a VMware product which is +present in the customer Environemnt. The following information about the +products are present:

+
    +

  • Name

    • +

  • Version

    • +

  • Deployments

    • +

  • Automatically Discovered or Manually Added

    • +
+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • installed_product (str) –

    Identifies a product and a version uniquely.

    +

    The identifier consists of product internal name and version. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: PRODUCT. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: PRODUCT.

    +

    • +

  • name (str) – A public official product name.

    • +

  • version (str) – Current product version.

    • +

  • target_version (str or None) – Future version of the product after upgrade. +targetVersion may not be applicable.

    • +

  • deployments (list of str or None) – The list of hostname/IPs of the instances of the VMware products +deployed in the environment. This field would be empty for manually +added products.

    • +

  • auto (bool) – Indicates if the product is auto-detected by the system or manually +added. If it is set to true it means it is auto-detected.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.lcm.discovery_client.ProductCatalog(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ProductCatalog class provides information which VMware products can +be associated with vCenter Server.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Summary(name=None, versions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ProductCatalog.Summary class contains information about each VMware +product and its corresponding versions that can be associated with vCenter +Server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – A product name that the customer is aware of.

    • +

  • versions (list of str) – List of versions the customer can select from.

    • +
+
+
+
+ +
+
+list()
+

Retrieves a list of all VMware products that can be associated with +vCenter Server.

+
+
Return type
+

list of ProductCatalog.Summary

+
+
Returns
+

List of all the VMware products which can be associated with +vCenter Server

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If there is some unknown internal error. The accompanying error +message will give more details about the failure.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.lcm.discovery_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.lcm.update_client module

+

The com.vmware.vcenter.lcm.update_client module provides classes for +updating vCenter Server to a newer version.

+
+
+class com.vmware.vcenter.lcm.update_client.Pending(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Pending class provides method for listing pending minor or major +updates of vCenter Server.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Category(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Pending.Category class defines the type of payload this release has +on top of previous release

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Category instance.

+
+
+
+
+FIX = Category(string='FIX')
+

Fixes bugs/vulnerabilities, doesn’t change functionality

+
+ +
+
+SECURITY = Category(string='SECURITY')
+

Fixes vulnerabilities, doesn’t change functionality

+
+ +
+
+UPDATE = Category(string='UPDATE')
+

Changes product functionality

+
+ +
+
+UPGRADE = Category(string='UPGRADE')
+

Introduces new features, significantly changes product functionality

+
+ +
+ +
+
+class Info(description=None, pending_update=None, version=None, release_date=None, severity=None, build=None, update_type=None, category=None, reboot_required=None, execute_url=None, release_notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Pending.Info class contains detailed information about the vCenter +patch/update.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • description (str) – Description of the vSphere update

    • +

  • pending_update (str) – Identifier of the given vSphere update +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.lcm.update.pending. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.lcm.update.pending.

    • +

  • version (str) – Version of the vSphere update or patch

    • +

  • release_date (datetime.datetime) – Release date of the vSphere update or patch

    • +

  • severity (Pending.SeverityType) – Severity of the issues fixed in the vSphere update or patch

    • +

  • build (str) – Build number of the vCenter Release

    • +

  • update_type (Pending.UpdateType) – Type of the Release based on the current vCenter version

    • +

  • category (Pending.Category) – Category of the release based on features bundled on top of +previous release

    • +

  • reboot_required (bool) – Flag to suggest a reboot after the release is applied

    • +

  • execute_url (str) – VAMI or ISO URL for update or upgrade execute phase redirection

    • +

  • release_notes (list of str) – List of URI pointing to patch or update release notes

    • +
+
+
+
+ +
+
+class ListResult(last_check_time=None, update_count=None, upgrade_count=None, updates=None, issues=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Pending.ListResult class contains information about the pending +patch/updates for the given vCenter server.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • last_check_time (datetime.datetime) – Time when the software depo was last checked.

    • +

  • update_count (long or None) – Number of pending updates +Only set if there are available updates

    • +

  • upgrade_count (long or None) – Number of pending upgrades +Only set if there are available upgrades

    • +

  • updates (list of Pending.Summary) – List of pending update details

    • +

  • issues (com.vmware.vcenter.lcm_client.Notifications or None) – Lists of issues encountered during pending updates retrieval. +set if any issues encountered.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.lcm.update.pending'
+

Resource type for pending update

+
+ +
+
+class SeverityType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Level of severity for applying a given patch or update.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SeverityType instance.

+
+
+
+
+CRITICAL = SeverityType(string='CRITICAL')
+

Vulnerabilities that can be exploited by an unauthenticated attacker from +the Internet or those that break the guest/host Operating System isolation.

+
+ +
+
+IMPORTANT = SeverityType(string='IMPORTANT')
+

Vulnerabilities that are not rated critical but whose exploitation results +in the complete compromise of confidentiality and/or integrity of user data +and/or processing resources through user assistance or by authenticated +attackers.

+
+ +
+
+LOW = SeverityType(string='LOW')
+

All other issues that may or maynot have a security impact. Vulnerabilities +where exploitation is believed to be extremely difficult, or where +successful exploitation would have minimal impact.

+
+ +
+
+MODERATE = SeverityType(string='MODERATE')
+

Vulnerabilities where the ability to exploit is mitigated to a significant +degree by configuration or difficulty of exploitation, but in certain +deployment scenarios could still lead to the compromise of confidentiality, +integrity, or availability of user data and/or processing resources.

+
+ +
+ +
+
+class Summary(pending_update=None, version=None, release_date=None, severity=None, build=None, update_type=None, category=None, reboot_required=None, execute_url=None, release_notes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Pending.Summary class contains basic information about the vCenter +patch/update/upgrade

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pending_update (str) – Identifier of the given vSphere update +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.lcm.update.pending. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.lcm.update.pending.

    • +

  • version (str) – Version of the vSphere update or patch

    • +

  • release_date (datetime.datetime) – Release date of the vSphere update or patch

    • +

  • severity (Pending.SeverityType) – Severity of the issues fixed in the vSphere update or patch

    • +

  • build (str) – Build number of the vCenter Release

    • +

  • update_type (Pending.UpdateType) – Type of the Release based on the current vCenter version

    • +

  • category (Pending.Category) – Category of the release based on features bundled on top of +previous release

    • +

  • reboot_required (bool) – Flag to suggest a reboot after the release is applied

    • +

  • execute_url (str) – VAMI or ISO URL for update or upgrade execute phase redirection

    • +

  • release_notes (list of str) – List of URI pointing to patch or update release notes

    • +
+
+
+
+ +
+
+class UpdateType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Pending.UpdateType class defines update type

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the UpdateType instance.

+
+
+
+
+PATCH = UpdateType(string='PATCH')
+

Fixes bugs/vulnerabilities, doesn’t change functionality

+
+ +
+
+UPDATE = UpdateType(string='UPDATE')
+

Changes product functionality

+
+ +
+
+UPGRADE = UpdateType(string='UPGRADE')
+

Introduces new features, significantly changes product functionality

+
+ +
+ +
+
+get(version)
+

Gets detailed update information.

+
+
Parameters
+

version (str) – A version identified the update +The parameter must be an identifier for the resource type: +com.vmware.vcenter.lcm.update.pending.

+
+
Return type
+

Pending.Info

+
+
Returns
+

A detailed information about the particular vCenter patch/update

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no pending update assosiated with the version in +the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is some unknown internal error. The accompanying error +message will give more details about the error.

+
+
+
+ +
+
+list()
+

Lists all available minor and major updates.

+
+
Return type
+

Pending.ListResult

+
+
Returns
+

Information about the pending patch/updates for the given vCenter +server

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is some unknown internal error. The accompanying error +message will give more details about the error.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.lcm.update_client.PrecheckReport(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The PrecheckReport class generates precheck report for a vCenter Server +instance against a target update version.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+RESOURCE_TYPE = 'com.vmware.vcenter.lcm.report'
+

Resource type for precheck report

+
+ +
+
+class Report(date_created=None, estimated_time_to_update=None, issues=None, summary=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrecheckReport.Report class contains estimates of how long it will +take an update as well as a list of possible warnings and errors with +applying the update.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • date_created (datetime.datetime) – Time when this precheck report was generated

    • +

  • estimated_time_to_update (long or None) – Rough estimate of time to update vCenter Server in minutes. +This attribute will be None if the precheck failed.

    • +

  • issues (com.vmware.vcenter.lcm_client.Notifications or None) – Lists of the issues and warnings +This attribute will be None if the precehck is successful.

    • +

  • summary (PrecheckReport.ReportSummary) – A summary of the report consist of count of warnings and errors +returned by running the precheck.

    • +
+
+
+
+ +
+
+class ReportSummary(error_count=None, warning_count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Summary Class contains the summary of precheck report.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • error_count (long) – Number of errors detected by precheck process

    • +

  • warning_count (long) – Number of warnings detected by precheck process

    • +
+
+
+
+ +
+
+class Result(report=None, csv_report=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PrecheckReport.Result class contains the precheck report and a link +to download the CSV report.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • report (PrecheckReport.Report) – The report generated by running the precheck.

    • +

  • csv_report (str or None) – The identifier of CSV formatted precheck report. +com.vmware.vcenter.lcm.report#get provides location where the CSV +report can be downloaded from based on the csvReport. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.lcm.report. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: com.vmware.vcenter.lcm.report. +None in case of errors reported in +PrecheckReport.Report.issues.

    • +
+
+
+
+ +
+
+create_task(version)
+

Creates a vCenter Server pre-update compatibility check report for the +pending update version. The report can be exported and downloaded in +CSV format.

+

The result of this operation can be queried by calling the +com.vmware.cis.Tasks#get method where task is the response of this +operation.

+
+
Parameters
+

version (str) – Pending update version for which pre-update compatibility check +will be executed. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.lcm.update.pending.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no pending update assosiated with the version in +the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a precheck is already in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is some unknown internal error. The accompanying error +message will give more details about the error.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.lcm.update_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.html b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.html new file mode 100644 index 00000000..adfe2cc2 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.html @@ -0,0 +1,3665 @@ + + + + + + + com.vmware.vcenter.namespace_management package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.namespace_management package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.namespace_management.clusters_client module

+
+
+class com.vmware.vcenter.namespace_management.clusters_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.clusters_client.Topology(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Topology class provides methods to query the topological layout of +the infrastructure a Supervisor is running on. This class was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(cluster)
+

Queries the Supervisor ID that is currently running on the given +vSphere Cluster ID, if there’s any. A Supervisor can be running on one +or multiple vSphere Zones, and each vSphere Zone is associated with one +or more vSphere Clusters. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

cluster (str) – Identifier for a vSphere Cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

str

+
+
Returns
+

Identifier of the Supervisor associated with the given vSphere +Cluster. +The return value will be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the given vSphere Cluster does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege and the +System.Read privilege on all vSphere Clusters hosting the +Supervisor.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.namespace_management.cns_client module

+

The com.vmware.vcenter.namespace_management.cns_client module provides +classes for configuration of Persistent Services capabilities on VC clusters.

+
+
+class com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The MaintenanceActionType class contains actions to be taken when an +entity enters maintenance mode.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MaintenanceActionType instance.

+
+
+
+
+EnsureAccessibility = MaintenanceActionType(string='EnsureAccessibility')
+

The entity is going down temporarily for maintenance. Still need to ensure +application availability and storage accessibility at least in a degraded +level.

+
+ +
+
+NoAction = MaintenanceActionType(string='NoAction')
+

Admin override to not delay or stop the entity from entering maintenance +mode.

+
+ +
+
+PermanentRemoval = MaintenanceActionType(string='PermanentRemoval')
+

The entity is getting permanently removed. Move applications, rebuild +storage on other entities before allowing to proceed.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.cns_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.networks_client module

+
+
+class com.vmware.vcenter.namespace_management.networks_client.IPAssignment(assignee=None, ranges=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPAssignment class is used to assign IP addresses to be used for +various functions in a Supervisor Kubernetes Cluster. This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • assignee (IPAssignment.Assignment or None) – IPAssignment.assignee is the role assignee for the given IP +Ranges. This attribute was added in vSphere API 8.0.0.1. +This field defaults to ANY.

    • +

  • ranges (list of IPRange) – IPAssignment.ranges lists the available IP addresses that +can be consumed by Supervisor to run the cluster. This attribute +was added in vSphere API 8.0.0.1.

    • +
+
+
+
+
+class Assignment(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

IPAssignment.Assignment lists the different entities that require IP +ranges. These assignments fulfill different needs in the Kubernetes +environment. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Assignment instance.

+
+
+
+
+NODE = Assignment(string='NODE')
+

IPAssignment.Assignment.NODE represents IP ranges that is allocated +to nodes for both the control plane and Tanzu Kubernetes Grid Clusters. +This assignment is currently only applicable on VDS networks. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+POD = Assignment(string='POD')
+

IPAssignment.Assignment.POD represents the IP address that is +allocatable to Kubernetes Pods. This assignment is currently only +applicable on NSX-T networks. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SERVICE = Assignment(string='SERVICE')
+

IPAssignment.Assignment.SERVICE represents the IP ranges that +Kubernetes can use for its cluster IP addresses. Cluster IPs are internal +to the cluster, but can be exposed via edge services such as load balancer, +ingress, and egress. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks_client.IPManagement(dhcp_enabled=None, gateway_address=None, ip_assignments=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

IPManagement class dictates IP addressing configuration for the network +that hosts the Supervisor. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dhcp_enabled (bool or None) – IPManagement.dhcp_enabled If set true, configures IP +address using the DHCP server on the broadcast domain unless the +corresponding IPManagement.ip_assignments are set. This +attribute was added in vSphere API 8.0.0.1. +If None this field defaults to true.

    • +

  • gateway_address (str or None) – IPManagement.gateway_address is the IP address combined +with the subnet prefix length (e.g. 192.168.1.1/24) of the default +gateway of this network. This attribute was added in vSphere API +8.0.0.1. +If IPManagement.dhcp_enabled is not set, or this is an NSX +network, this address must be set.

    • +

  • ip_assignments (list of IPAssignment or None) – IPManagement.ip_assignments are a list of roles that can be +allocated to IP addresses. If IPManagement.gateway_address +is specified, these assignments must be on the same subnet. This +attribute was added in vSphere API 8.0.0.1. +These assignments are optional when using DHCP.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks_client.IPRange(address=None, count=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IPRange class is used to express a range of IP addresses. The IP +address supported by this structure will depend on the IP version that is +being used by Supervisor.

+

Currently, the Supervisor only supports IPv4.. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (str) – IPRange.address is the starting IP address of the +IPRange. This attribute was added in vSphere API 8.0.0.1.

    • +

  • count (long) –

    IPRange.count is number of IP addresses in the range.

    +

    For example:

    +

    A /24 subnet will have a count of 256.

    +

    A /24 subnet with a gateway address and a broadcast address will +have a count of 254.. This attribute was added in vSphere API +8.0.0.1.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks_client.Services(dns=None, ntp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Services class describes services that assists applications in +communicating on a network. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.software_client module

+

The com.vmware.vcenter.namespace_management.software_client module provides +classes for managing namespaces software components.

+
+
+class com.vmware.vcenter.namespace_management.software_client.Clusters(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Clusters class provides methods to upgrade the vSphere clusters.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(current_version=None, available_versions=None, last_upgraded_date=None, messages=None, state=None, upgrade_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Info class contains detailed information about the cluster +upgrade status and related information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • current_version (str) – Current version of the cluster.

    • +

  • available_versions (list of str) – Set of available versions can be upgraded to.

    • +

  • last_upgraded_date (datetime.datetime or None) – Date of last successful upgrade. +If None, the cluster has not yet been upgraded.

    • +

  • messages (list of Clusters.Message) – Current set of messages associated with the cluster version.

    • +

  • state (Clusters.State) – Current state of the upgrade.

    • +

  • upgrade_status (Clusters.UpgradeStatus or None) – Information about upgrade in progress. +If None, the cluster upgrade is not in progress.

    • +
+
+
+
+ +
+
+class Message(severity=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Message class contains the information about the object +configuration.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class Severity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.Message.Severity class represents the severity of the +message.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Severity instance.

+
+
+
+
+ERROR = Severity(string='ERROR')
+

Error message. This is accompanied by vCenter event and/or alarm.

+
+ +
+
+INFO = Severity(string='INFO')
+

Informational message. This may be accompanied by vCenter event.

+
+ +
+
+WARNING = Severity(string='WARNING')
+

Warning message. This may be accompanied by vCenter event.

+
+ +
+ +
+ +
+
+class Result(res=None, exception=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Result class contains the result of batch upgrade method.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • res (Clusters.Result.Res) – The result of batch upgrade method.

    • +

  • exception (Exception) – Exception when cluster pre-check failed during upgrade invocation. +This attribute is optional and it is only relevant when the value +of res is Clusters.Result.Res.REJECTED.

    • +
+
+
+
+
+class Res(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.Result.Res class represents the upgrade invocation result +for each cluster.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Res instance.

+
+
+
+
+REJECTED = Res(string='REJECTED')
+

Upgrade is rejected. This implies pre-check failed when invoking upgrade of +the cluster.

+
+ +
+
+STARTED = Res(string='STARTED')
+

Upgrade is started.

+
+ +
+ +
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Clusters.State class describes the state of the upgrade.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+ERROR = State(string='ERROR')
+

Upgrade failed and need user intervention.

+
+ +
+
+PENDING = State(string='PENDING')
+

Upgrade is in progress.

+
+ +
+
+READY = State(string='READY')
+

Cluster is ready when there is no upgrade or upgrade is completed.

+
+ +
+ +
+
+class Summary(cluster=None, cluster_name=None, current_version=None, available_versions=None, last_upgraded_date=None, desired_version=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.Summary class contains basic information about the cluster +upgrade related information.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource.

    • +

  • cluster_name (str) – Name of the cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource.name. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: ClusterComputeResource.name.

    • +

  • current_version (str) – Current version of the cluster.

    • +

  • available_versions (list of str) – Set of versions available for upgrade.

    • +

  • last_upgraded_date (datetime.datetime or None) – Date of last successful upgrade. +If None, the cluster has not yet been upgraded.

    • +

  • desired_version (str or None) – Desired version the cluster will be upgraded to. +If None, the cluster upgrade is not in progress.

    • +

  • state (Clusters.State) – Current state of the upgrade.

    • +
+
+
+
+ +
+
+class UpgradeProgress(total=None, completed=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.UpgradeProgress class contains detailed information about +the cluster upgrade progess.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • total (long) – Total amount of the work for the operation. The work here +represents the number of master nodes in the cluster need to be +upgraded.

    • +

  • completed (long) – The amount of work completed for the operation. The value can only +be incremented. The number or master nodes which upgrade completed.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage) – Message about the work progress.

    • +
+
+
+
+ +
+
+class UpgradeSpec(desired_version=None, ignore_precheck_warnings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.UpgradeSpec class contains the specification required to +upgrade a cluster.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • desired_version (str) – Version number the cluster is going to be upgraded to.

    • +

  • ignore_precheck_warnings (bool or None) – If true, the upgrade workflow will ignore any pre-check warnings +and proceed with the upgrade. +If None, the upgrade workflow will not ignore pre-check warnings +and fail the upgrade. It is equivalent to setting the value to +false. The workflow adopts a conservative approach of failing the +upgrade if None to solely let the user decide whether to force the +upgrade despite the warnings.

    • +
+
+
+
+ +
+
+class UpgradeStatus(desired_version=None, messages=None, progress=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Clusters.UpgradeStatus class contains detailed information about +the cluster when upgraded is in progress.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • desired_version (str or None) – Desired version the cluster will be upgraded to. +If None, the cluster upgrade is not in progress.

    • +

  • messages (list of Clusters.Message) – Current set of messages associated with the upgrade state.

    • +

  • progress (Clusters.UpgradeProgress or None) – Information about upgrade progess. +If None, the cluster upgrade is not in progress.

    • +
+
+
+
+ +
+
+get(cluster)
+

Returns upgrade related information of a specific cluster.

+
+
Parameters
+

cluster (str) – Identifier for the cluster which will be upgraded. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

Clusters.Info

+
+
Returns
+

Information about the upgrade of the specified WCP enabled cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the cluster is not WCP enabled.

+
+
+
+ +
+
+list()
+

Returns upgrade related information about all WCP enabled clusters.

+
+
Return type
+

list of Clusters.Summary

+
+
Returns
+

List of upgrade summary of all WCP enabled clusters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+
+upgrade(cluster, spec)
+

Upgrade the cluster to a specific version. This operation upgrades the +components on control plane VMs and worker plane hosts based on the +selected version. Before upgrading, this operation performs pre-checks +and sets the evaluation response in Info.UpgradeStatus.messages with +various Message.Severity levels. Depending on the severity, the upgrade +may or may not proceed beyond prechecks. Here is a list of severities +and corresponding behavior: - ERROR: Upgrade does not proceed beyond +precheck operation - WARNING: Upgrade proceeds beyond precheck +operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - +INFO: Upgrade proceeds beyond precheck operation uninterrupted

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster which will be upgraded. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Clusters.UpgradeSpec) – Specification for upgrading the cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if pre-check failed of the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Upgrade privilege.

+
+
+
+ +
+
+upgrade_multiple(specs)
+

Upgrade a set of clusters to its corresponding specific version.

+
+
Parameters
+

specs (dict of str and Clusters.UpgradeSpec) – Specifications for upgrading selected clusters. +The key in the parameter dict must be an identifier for +the resource type: ClusterComputeResource.

+
+
Return type
+

dict of str and Clusters.Result

+
+
Returns
+

Pre-check result when invoking upgrade for each cluster. +The key in the return value dict will be an identifier for +the resource type: ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Upgrade privilege on all +specified clusters.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.software_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.stats_client module

+

The com.vmware.vcenter.namespace_management.stats_client module provides +classes for gathering statistics related to various Namespaces related +components.

+
+
+class com.vmware.vcenter.namespace_management.stats_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.stats_client.TimeSeries(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The TimeSeries class provides methods to gather statistical values for +clusters, namespaces and pods.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class PodIdentifier(namespace=None, pod_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Pod identifier. These are the fields required to uniquely identify a pod.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace (str) – The namespace that the pod is running in. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • pod_name (str) – The name of the pod itself.

    • +
+
+
+
+ +
+
+class Spec(obj_type=None, pod=None, namespace=None, cluster=None, start=None, end=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

This structure is sent in a request for TimeSeries data and is used to +specify what object stats should be returned for.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • obj_type (TimeSeries.Spec.ObjType) – Type of statistics object that the request is operating on.

    • +

  • pod (TimeSeries.PodIdentifier) – Pod Identifier for queries on an individual pod. +This attribute is optional and it is only relevant when the value +of objType is TimeSeries.Spec.ObjType.POD.

    • +

  • namespace (str) – Namespace name for queries for a namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. +This attribute is optional and it is only relevant when the value +of objType is TimeSeries.Spec.ObjType.NAMESPACE.

    • +

  • cluster (str) – Cluster identifier for queries for a cluster. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +This attribute is optional and it is only relevant when the value +of objType is TimeSeries.Spec.ObjType.CLUSTER.

    • +

  • start (long) – UNIX timestamp value indicating when the requested series of +statistical samples should begin. +https://en.wikipedia.org/wiki/Unix_time

    • +

  • end (long) – UNIX timestamp value indicating when the requested series of +statistical samples should end. +https://en.wikipedia.org/wiki/Unix_time

    • +
+
+
+
+
+class ObjType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Type of statistics object that this request is operating on.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ObjType instance.

+
+
+
+
+CLUSTER = ObjType(string='CLUSTER')
+

The CLUSTER object type is used when specifying a vSphere cluster.

+
+ +
+
+NAMESPACE = ObjType(string='NAMESPACE')
+

The NAMESPACE object type is used to specify a namespace.

+
+ +
+
+POD = ObjType(string='POD')
+

The POD object type is used to specify an individual pod within a +namespace.

+
+ +
+ +
+ +
+
+class TimeSeries(counter=None, time_stamps=None, values=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A set of timestamps and statistical values representing a time series. The +lengths of TimeSeries.TimeSeries.time_stamps and +TimeSeries.TimeSeries.values will always match each other.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • counter (str) – Counter identifier.

    • +

  • time_stamps (list of long) – Sequence of UNIX timestamp values at which statistical values were +sampled. https://en.wikipedia.org/wiki/Unix_time

    • +

  • values (list of long) – Sequence of sampled values corresponding to the timestamps in tss.

    • +
+
+
+
+ +
+
+get(spec)
+

Gather statistical values for a cluster, namespace, or pod.

+
+
Parameters
+

spec (TimeSeries.Spec) – Specification of the statistical values that should be returned.

+
+
Return type
+

list of TimeSeries.TimeSeries

+
+
Returns
+

A list of TimeSeries values for each counter specified in the +request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the start time in TimeSeries.Spec.start is invalid, or +the end time in TimeSeries.Spec.end is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified cluster in TimeSeries.Spec.cluster or the +namespace in TimeSeries.Spec.namespace or +TimeSeries.Spec.pod does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified cluster in TimeSeries.Spec.cluster is not +enabled for Namespaces.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.namespace_management.storage_client module

+
+
+class com.vmware.vcenter.namespace_management.storage_client.Profiles(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Profiles class provides methods to get storage profiles compatible +with control plane VMDKs which can be used to enable a Supervisor. A +storage profile is compatible if it results in at least one datastore in +each of the specified zones. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(zones=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Profiles.FilterSpec class contains zones used to find compatible +storage profiles. A storage profile is compatible if it results in at least +one datastore in each of the specified zones. (see Profiles.check()). +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

zones (list of str) – Zone compatibility criteria. The common storage profiles across the +given zones will be returned. A storage profile is considered +compatible if it results in at least one datastore in each of the +given zones. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

+
+
+
+ +
+
+class Item(zone=None, datastores=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Profiles.Item class contains the datastores and vSphere Zone which +they are in. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str) – The vSphere Zones the datastore are in. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • datastores (list of str) – The datastores in the zone. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +Datastore. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: Datastore.

    • +
+
+
+
+ +
+
+class Summary(profile=None, profile_name=None, compatible=None, items=None, incompatibility_reasons=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Profiles.Summary class contains the information about compatible +storage profiles and represents the result of Profiles.check() +method. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • profile (str) – Identifier of the compatible storage profile. A storage profile is +compatible if it results in at least one datastore in each of the +specified zones. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile.

    • +

  • profile_name (str) – Human-readable identifier of the storage profile. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • compatible (bool) – Compatibility of this storage profile with the specified vSphere +Zones. This attribute was added in vSphere API 8.0.0.1.

    • +

  • items (list of Profiles.Item) – The list of Profiles.Item wich correspond to the storage +profile. This attribute was added in vSphere API 8.0.0.1.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – The reason for incompatibility. If empty, this profile is +compatible with the given vSphere Zones specified in the +Profiles.FilterSpec. This attribute was added in vSphere +API 8.0.0.1.

    • +
+
+
+
+ +
+
+check(filter)
+

Returns the compatible management storage profiles for enabling a WCP +Supervisor across a given set of zones. A storage profile is compatible +if it results in at least one datastore in each of the specified zones. +This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

filter (Profiles.FilterSpec) – Specification of the zones to consider when finding compatible +storage profiles. The Profiles.FilterSpec must contain at +least 1 zone.

+
+
Return type
+

list of Profiles.Summary

+
+
Returns
+

List of storage profiles compatible across the given +Profiles.FilterSpec. The profiles returned will each +result in at least one datastore in each zone.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one or more fields of the Profiles.FilterSpec is +incorrect.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege on all of the +Cluster Compute Resources in the specified vSphere Zones.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.storage_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.supervisor_services_client module

+

The com.vmware.vcenter.namespace_management.supervisor_services_client +module provides classes for managing supervisor services that are extensions to +the Supervisor.

+
+
+class com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ClusterSupervisorServices class provides methods to manage a +Supervisor Service on the vSphere Supervisors. This class was added in +vSphere API 7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfigStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ClusterSupervisorServices.ConfigStatus class describes the status +of reaching the desired state configuration for the Supervisor Service. +This enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigStatus instance.

+
+
+
+
+CONFIGURED = ConfigStatus(string='CONFIGURED')
+

The Supervisor Service has been configured correctly (i.e. the provided +YAML content has been applied successfully to the cluster). This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+CONFIGURING = ConfigStatus(string='CONFIGURING')
+

The Supervisor Service is being installed. This class attribute was added +in vSphere API 7.0.3.0.

+
+ +
+
+ERROR = ConfigStatus(string='ERROR')
+

Failed to install the Supervisor Service, user intervention needed. This +class attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+REMOVING = ConfigStatus(string='REMOVING')
+

The Supervisor Service is being deleted. This class attribute was added in +vSphere API 7.0.3.0.

+
+ +
+ +
+
+class CreateSpec(supervisor_service=None, version=None, service_config=None, yaml_service_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSupervisorServices.CreateSpec class provides a specification +required to create a Supervisor Service on a vSphere Supervisor. This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier of the Supervisor Service. This Supervisor Service must +be in the ACTIVATED state. This attribute was added in vSphere +API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – Identifier of the Supervisor Service version which contains the +service definition. This Supervisor Service version must be in the +ACTIVATED state. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +

  • service_config ((dict of str and str) or None) – A generic key-value map for additional configuration parameters +required during service creation. As an example, a third party +operator might reference a private registry using parameters such +as “registryName” for the registry name, “registryUsername” and +“registryPassword” for the registry credentials. This attribute was +added in vSphere API 7.0.3.0. +If None, no additional configuration parameters will be applied +when installing a Supervisor Service in the vSphere Supervisor.

    • +

  • yaml_service_config (str or None) –

    A set of additional configuration parameters to be applied during +service creation. These parameters should be formatted as a base64 +encoded YAML document.

    +

    Parameters should be set in at most one of +serviceConfig or yamlServiceConfig, and not both. The +yamlServiceConfig supports complex data types and nested +properties.. This attribute was added in vSphere API 8.0.0.1. +If None, no additional configuration parameters will be applied +when installing a Supervisor Service in the vSphere Supervisor.

    +

    • +
+
+
+
+ +
+
+class Info(desired_version=None, service_namespace=None, config_status=None, messages=None, current_version=None, display_name=None, description=None, prefix=None, yaml_service_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSupervisorServices.Info class contains the detailed +information about a Supervisor Service on the vSphere Supervisor. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • desired_version (str) – The desired version of this Supervisor Service. This attribute was +added in vSphere API 7.0.3.0.

    • +

  • service_namespace (str or None) – Identifier of the namespace to allocate the Supervisor Service’s +operators. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. +If None, there is an error when creating the service namespace or +the namespace has not been created yet.

    • +

  • config_status (ClusterSupervisorServices.ConfigStatus) – Current setting for ClusterSupervisorServices.ConfigStatus. +This attribute was added in vSphere API 7.0.3.0.

    • +

  • messages (list of ClusterSupervisorServices.Message) – Current set of messages associated with the Supervisor Service on +the vSphere Supervisor. This attribute was added in vSphere API +7.0.3.0.

    • +

  • current_version (str or None) – The current version for the Supervisor Service. This attribute was +added in vSphere API 7.0.3.0. +If None, there is no version installed for the Supervisor Service.

    • +

  • display_name (str) – A human readable name of the Supervisor Service. This attribute was +added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human readable description of the Supervisor Service. This +attribute was added in vSphere API 7.0.3.0. +If None, the description for the service version is empty.

    • +

  • prefix (str or None) – The prefix that will be added to the names of the Supervisor +Service’s kubernetes resources. This attribute was added in vSphere +API 7.0.3.0. +If None, the prefix is not assigned yet.

    • +

  • yaml_service_config (str or None) – The configuration parameters applied on this Supervisor Service, +formatted as a base64 encoded YAML document. Any configuration that +has been set will be returned as base64 encoded YAML, +including the serviceConfig. This attribute was added in +vSphere API 8.0.0.1. +If None, the Supervisor Service has no configuration applied.

    • +
+
+
+
+ +
+
+class Message(severity=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSupervisorServices.Message class contains the information +about the Supervisor Service configuration on a vSphere Supervisor. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+
+class MessageSeverity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ClusterSupervisorServices.Message.MessageSeverity class represents +the severity of the message. This enumeration was added in vSphere API +7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MessageSeverity instance.

+
+
+
+
+ERROR = MessageSeverity(string='ERROR')
+

Error message. This is accompanied by vCenter event and/or alarm. This +class attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+INFO = MessageSeverity(string='INFO')
+

Informational message. This may be accompanied by vCenter event. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+WARNING = MessageSeverity(string='WARNING')
+

Warning message. This may be accompanied by vCenter event. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+ +
+
+class SetSpec(version=None, service_config=None, yaml_service_config=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSupervisorServices.SetSpec class provides a specification +required to set a new configuration on a Supervisor Service in a vSphere +Supervisor. This class is applied in entirety, replacing the current +specification fully. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – Identifier of the Supervisor Service version which contains the +service definition. This Supervisor Service version must be in the +ACTIVATED state. This attribute was added in vSphere API +7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +

  • service_config ((dict of str and str) or None) – A generic key-value map for additional configuration parameters +required during service upgrade. As an example, a third party +operator might reference a private registry using parameters such +as “registryName” for the registry name, “registryUsername” and +“registryPassword” for the registry credentials. This attribute was +added in vSphere API 7.0.3.0. +If None, no additional configuration parameters will be applied +when upgrading a Supervisor Service in the vSphere Supervisor.

    • +

  • yaml_service_config (str or None) –

    A set of additional configuration parameters to be applied during +service upgrade. These parameters should be formatted as a base64 +encoded YAML document.

    +

    Parameters should be set in at most one of +serviceConfig or yamlServiceConfig, and not both. The +yamlServiceConfig supports complex data types and nested +properties.. This attribute was added in vSphere API 8.0.0.1. +If None, no additional configuration parameters will be applied +when upgrading a Supervisor Service in the vSphere Supervisor.

    +

    • +
+
+
+
+ +
+
+class Summary(supervisor_service=None, desired_version=None, config_status=None, current_version=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClusterSupervisorServices.Summary class contains the basic +information about a Supervisor Service on the vSphere Supervisor. This +class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor_service (str) – The identifier of the Supervisor Service. This attribute was added +in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • desired_version (str) – The desired version of this Supervisor Service. This attribute was +added in vSphere API 7.0.3.0.

    • +

  • config_status (ClusterSupervisorServices.ConfigStatus) – Current setting for ClusterSupervisorServices.ConfigStatus. +This attribute was added in vSphere API 7.0.3.0.

    • +

  • current_version (str or None) – The current version for the Supervisor Service. This attribute was +added in vSphere API 7.0.3.0. +If None, there is no version installed for the Supervisor Service.

    • +
+
+
+
+ +
+
+create(cluster, spec)
+

Create a Supervisor Service on the specified vSphere Supervisor. This +method will apply the Supervisor Service version’s service definition +on the cluster. This method is possible only when the Supervisor +Service and Supervisor Service version are in the ACTIVATED state. +A Supervisor can be running on one or multiple vSphere Zones, and each +vSphere Zone is associated with one or more vSphere Clusters. If a +Supervisor running on the specified vSphere Cluster is running on +additional vSphere Clusters, this operation will apply to Supervisor +components running on the other vSphere Clusters in addition to the +specified vSphere Cluster. To call this API on a Supervisor with +multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the Supervisor on which to create the service. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (ClusterSupervisorServices.CreateSpec) – Specification for the Supervisor Service on the cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a Supervisor Service ID defined in spec exists on the +Supervisor

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the specified cluster with ID cluster or Supervisor Service +with the Supervisor Service ID defined in spec or version with +the ID {param.name version} could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor doesn’t support Supervisor Services, or if the +Supervisor Service cannot be created in the current state, e.g. the +supervisor service version is in the DEACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege +on the specified cluster.

+
+
+
+ +
+
+delete(cluster, supervisor_service)
+

Delete a Supervisor Service on the specified vSphere Supervisor. This +method will remove the Supervisor Service with the specified identifier +from the cluster, by removing the corresponding namespace and deleting +the operator(s) associated with the Supervisor Service. Note that this +operation doesn’t deal with the application instances that are created +by the associated operator(s), so existing application instances could +be orphaned if users don’t clean or migrate them. A Supervisor can be +running on one or multiple vSphere Zones, and each vSphere Zone is +associated with one or more vSphere Clusters. If a Supervisor running +on the specified vSphere Cluster is running on additional vSphere +Clusters, this operation will apply to Supervisor components running on +the other vSphere Clusters in addition to the specified vSphere +Cluster. To call this API on a Supervisor with multiple vSphere +Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the Supervisor from which to delete the service. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor with the ID cluster or the Supervisor Service +does not exist on the Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor doesn’t support Supervisor Services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege +on the specified cluster.

+
+
+
+ +
+
+get(cluster, supervisor_service)
+

Return information about the specific Supervisor Service on the +specified vSphere Supervisor. A Supervisor can be running on one or +multiple vSphere Zones, and each vSphere Zone is associated with one or +more vSphere Clusters. If a Supervisor running on the specified vSphere +Cluster is running on additional vSphere Clusters, this operation will +apply to Supervisor components running on the other vSphere Clusters in +addition to the specified vSphere Cluster. To call this API on a +Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the cluster on which to get the service. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +
+
+
Return type
+

ClusterSupervisorServices.Info

+
+
Returns
+

The information for the specified Supervisor Service on the +specified cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor with the ID cluster or the Supervisor Service +does not exist on the Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor doesn’t support Supervisor Services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege +on the specified cluster.

+
+
+
+ +
+
+list(cluster)
+

Return the summaries about all Supervisor Services on the specified +vSphere Supervisor. A Supervisor can be running on one or multiple +vSphere Zones, and each vSphere Zone is associated with one or more +vSphere Clusters. If a Supervisor running on the specified vSphere +Cluster is running on additional vSphere Clusters, this operation will +apply to Supervisor components running on the other vSphere Clusters in +addition to the specified vSphere Cluster. To call this API on a +Supervisor with multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

cluster (str) – Identifier for the cluster on which to list the services. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

list of ClusterSupervisorServices.Summary

+
+
Returns
+

The list of summaries of all Supervisor Services on the cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor with the ID cluster could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor doesn’t support Supervisor Services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege +on the specified cluster.

+
+
+
+ +
+
+set(cluster, supervisor_service, spec)
+

Set a new configuration to the specified Supervisor Service on the +specified vSphere Supervisor. This method will apply the new Supervisor +Service version’s service definition to the existing Supervisor Service +on the cluster. This method requires that the specified Supervisor +Service is already installed in the specified Supervisor. Note that +this operation doesn’t interfere with the application instances that +are created by the associated operator(s). So users should make sure +the new version is still compatible with the existing application +instances. A Supervisor can be running on one or multiple vSphere +Zones, and each vSphere Zone is associated with one or more vSphere +Clusters. If a Supervisor running on the specified vSphere Cluster is +running on additional vSphere Clusters, this operation will apply to +Supervisor components running on the other vSphere Clusters in addition +to the specified vSphere Cluster. To call this API on a Supervisor with +multiple vSphere Clusters, use +com.vmware.vcenter.namespace_management.supervisors.Topology#get to get +the vSphere Clusters associated with the given Supervisor. Any cluster +from the list returned can be used as the input of this API. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier for the Supervisor from which to delete the service. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • spec (ClusterSupervisorServices.SetSpec) – Specification for the Supervisor Service on the cluster.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor with the ID cluster or Supervisor Service with +the ID supervisor_service or version with the ID {param.name +version} could not be located, or the Supervisor Service does not +exist on the Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor doesn’t support Supervisor Services or the +specified version is not in the ACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege +on the specified cluster.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisor_services_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisor_services_client.Versions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Versions class provides methods to manage a version object of a +Supervisor Service. A Supervisor Service version can be enabled on the +vSphere Supervisor. This class was added in vSphere API 7.0.3.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CarvelCreateSpec(content=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.CarvelCreateSpec class provides a specification required +to create a Supervisor Service version from Carvel application package +format (Package and PackageMetadata resources should be declared). This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

content (str) – Inline content that contains all service definition of the version +in Carvel application package format, which shall be base64 +encoded. This attribute was added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+class ContentType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Versions.ContentType class defines the type of content that +describes the format of Supervisor Service version definition. This +enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ContentType instance.

+
+
+
+
+CARVEL_APPS_YAML = ContentType(string='CARVEL_APPS_YAML')
+

The Supervisor Service version definition is provided as inline YAML +document that follows the Carvel application package format. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+CUSTOM_YAML = ContentType(string='CUSTOM_YAML')
+

The Supervisor Service version definition is provided as inline YAML +document that follows a plain Kubernetes YAML format. This class attribute +was added in vSphere API 7.0.3.0.

+
+ +
+
+VSPHERE_APPS_YAML = ContentType(string='VSPHERE_APPS_YAML')
+

The Supervisor Service version definition is provided as inline YAML +document that follows the vSphere application service format. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class CreateSpec(custom_spec=None, vsphere_spec=None, carvel_spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.CreateSpec class provides a specification required to +create a Supervisor Service version. Exactly one of +Versions.CreateSpec.custom_spec or +Versions.CreateSpec.vsphere_spec must be set. This class +was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • custom_spec (Versions.CustomCreateSpec or None) –

    The specification required to create a Supervisor Service version +from inline content that is based on a plain Kubernetes YAML +format.

    +

    . This attribute was added in vSphere API 7.0.3.0. +If set, the service version will be created from inline +content based on a plain Kubernetes YAML format.

    +

    • +

  • vsphere_spec (Versions.VsphereCreateSpec or None) –

    The specification required to create a Supervisor Service version +from inline content that is based on the vSphere application +service format.

    +

    . This attribute was added in vSphere API 7.0.3.0. +If set, the service version will be created from inline +content based on the vSphere application service format.

    +

    • +

  • carvel_spec (Versions.CarvelCreateSpec or None) –

    The specification required to create a Supervisor Service version +from inline content that is based on the Carvel application package +format.

    +

    . This attribute was added in vSphere API 8.0.0.1. +If set, the service version will be created from inline +content based on the Carvel application package format (Package and +PackageMetadata resources should be declared).

    +

    • +
+
+
+
+ +
+
+class CustomCreateSpec(version=None, display_name=None, description=None, content=None, trusted_provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.CustomCreateSpec class provides a specification required +to create a Supervisor Service version from a plain Kubernetes YAML format. +This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – The identifier of the Supervisor Service version. This must be a +semantic version. This attribute was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +

  • display_name (str) – A human readable name of the Supervisor Service version. This +attribute was added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human readable description of the Supervisor Service version. +This attribute was added in vSphere API 7.0.3.0. +If None, the description for the service version will be empty.

    • +

  • content (str) – Inline content that contains all service definition of the version, +which shall be base64 encoded. The service definition here follows +a plain Kubernetes YAML format. This attribute was added in vSphere +API 7.0.3.0.

    • +

  • trusted_provider (bool or None) – Whether or not the Supervisor Service version is from a trusted +provider, this field must be set to false if the service version is +not from a trusted provider. If it is set to be true, but the +content is not signed or the signature is invalid, an +InvalidArgument will be thrown. This attribute was added in +vSphere API 7.0.3.0. +If None, the default value is true. In this case, the content +must be signed and will be verified.

    • +
+
+
+
+ +
+
+class Info(display_name=None, description=None, eula=None, content_type=None, content=None, trust_verified=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Info class contains detailed information about a +Supervisor Service version. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – The human readable name of the Supervisor Service version. This +attribute was added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human-readable description of the Supervisor Service version. +This attribute was added in vSphere API 7.0.3.0. +If None, no description is available for the Supervisor Service +version.

    • +

  • eula (str or None) – The End User License Agreement (EULA) associated with the +Supervisor Service version. This attribute was added in vSphere API +7.0.3.0. +If None, no EULA is available for the Supervisor Service version.

    • +

  • content_type (Versions.ContentType) – The content type of content. This attribute was added in +vSphere API 7.0.3.0.

    • +

  • content (str or None) – Inline content that contains base64 encoded service definition for +the version. This attribute was added in vSphere API 7.0.3.0. +If None, no content is available for the Supervisor Service +version.

    • +

  • trust_verified (bool) – If true, the Supervisor Service version is from trusted provider +and the trust is verified. This attribute was added in vSphere API +7.0.3.0.

    • +

  • state (Versions.State) – The current Versions.State of the version. This attribute was +added in vSphere API 7.0.3.0.

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Versions.State class defines the state of a Supervisor Service +version. This enumeration was added in vSphere API 7.0.3.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+ACTIVATED = State(string='ACTIVATED')
+

The is the default state of a Supervisor Service version upon creation. In +this state, all operations on the version should work as normal. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+DEACTIVATED = State(string='DEACTIVATED')
+

The is the deactivated state of a Supervisor Service version. In this +state, certain operations on the version are disallowed, for example, the +version cannot be created on the vSphere Supervisor clusters. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+ +
+
+class Summary(version=None, display_name=None, state=None, description=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Summary class contains the basic information about a +Supervisor Service version. This class was added in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – The identifier of the Supervisor Service version. This attribute +was added in vSphere API 7.0.3.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +

  • display_name (str) – A human readable name of the Supervisor Service version. This +attribute was added in vSphere API 7.0.3.0.

    • +

  • state (Versions.State) – The current Versions.State of the Supervisor Service version. +This attribute was added in vSphere API 7.0.3.0.

    • +

  • description (str or None) – A human readable description of the Supervisor Service version. +This attribute was added in vSphere API 7.0.3.0. +If None, no description is available for the service version.

    • +
+
+
+
+ +
+
+class VsphereCreateSpec(content=None, trusted_provider=None, accept_eula=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.VsphereCreateSpec class provides a specification required +to create a Supervisor Service version from vSphere application service +format, which shall contain the Supervisor Service identifier, version +identifier, display name and description information. This class was added +in vSphere API 7.0.3.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • content (str) – Inline content that contains all service definition of the version +in vSphere application service format, which shall be base64 +encoded. This attribute was added in vSphere API 7.0.3.0.

    • +

  • trusted_provider (bool or None) – Whether or not the Supervisor Service version is from a trusted +provider, this field must be set to false if the service version is +not from a trusted provider. If it is set to be true, but the +content is not signed or the signature is invalid, an +InvalidArgument will be thrown. This attribute was added in +vSphere API 7.0.3.0. +If None, the default value is true. In this case, the content +must be signed and will be verified.

    • +

  • accept_eula (bool or None) – Whether or not the End User License Agreement (EULA) that is +specified in the content is accepted. If a EULA is specified, +this attribute must be set to be true so that the Supervisor +Service version can be created. This attribute was added in vSphere +API 7.0.3.0. +If None, the default value is false.

    • +
+
+
+
+ +
+
+activate(supervisor_service, version)
+

Activate a Supervisor Service version. This method will change the +Versions.State of the version to ACTIVATED state. This method +was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – Identifier of the version. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service version cannot be activated in the +current state, for example, the Supervisor Service is in +DEACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service or version +with the ID {param.name version} could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+create(supervisor_service, spec)
+

Create a Supervisor Service version based on the provided service +definition information for the version. This method was added in +vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier of the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • spec (Versions.CreateSpec) – Specification for the Supervisor Service version to be created.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a Supervisor Service version with the same identifier already +exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if an invalid field in spec is specified or if it contains any +errors. For example, when the field trusted is set to be true, but +no signature is provided or it is invalid or when a EULA is +specified but not accepted.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service version cannot be created in the current +state, for example, the Supervisor Service is in DEACTIVATED +state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service could not +be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+deactivate(supervisor_service, version)
+

Deactivate a Supervisor Service version. This method will change the +Versions.State of the version to DEACTIVATED state, which will +make sure the version cannot be created on any Supervisor cluster. Note +that this method should be called before deleting the version. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier for the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – Identifier of the version. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service version cannot be deactivated in the +current state, for example, the Supervisor Service is in +ACTIVATED state and this version is the last version of the +Supervisor Service in ACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service or version +with the ID version could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+delete(supervisor_service, version)
+

Delete a Supervisor Service version. This method only deletes the +Supervisor Service version from vCenter if the version is in +DEACTIVATED state and all instances of the version are removed from +all Supervisors. Note that the deactivate method should be called +to deactivate the version before the version can be deleted.

+

Note that deleting the last version of the supervisor_service does +not delete the supervisor_service instance automatically.. This +method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier of the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – Identifier of the version. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request, +e.g. if it is unable to reach a vSphere Supervisor that has the +version enabled.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the Supervisor Service version cannot be deleted in the current +state, e.g. the version is not in DEACTIVATED state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service or version +with the ID {param.name version} could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the SupervisorServices.Manage privilege.

+
+
+
+ +
+
+get(supervisor_service, version)
+

Return the information for the specified Supervisor Service version. +This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+
    +

  • supervisor_service (str) – Identifier of the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

    • +

  • version (str) – Identifier of the version. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor_services.Version.

    • +
+
+
Return type
+

Versions.Info

+
+
Returns
+

Information for the specified Supervisor Service version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Supervisor Service with the ID supervisor_service or version +with the ID {param.name version} could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the System.Read privilege.

+
+
+
+ +
+
+list(supervisor_service)
+

Return the information about all versions of the Supervisor Service. +This method was added in vSphere API 7.0.3.0.

+
+
Parameters
+

supervisor_service (str) – Identifier of the Supervisor Service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.SupervisorService.

+
+
Return type
+

list of Versions.Summary

+
+
Returns
+

The list of summary of all service versions of the Supervisor +Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if service with the ID supervisor_service could not be located.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the System.Read privilege.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.namespace_management.supervisors_client module

+

The com.vmware.vcenter.namespace_management.supervisors_client module +provides classes for operating a Supervisor.

+
+
+class com.vmware.vcenter.namespace_management.supervisors_client.CNSFileConfig(vsan_clusters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CNSFileConfig class contains the specification required to set the +configuration for Cloud Native Storage file volume support on Supervisor. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

vsan_clusters (list of str) –

CNSFileConfig.vsan_clusters is a list of clusters to be +used for provisioning file volumes.

+

As a prerequisite these clusters must have vSAN and vSAN file +services enabled, and must be in the same vCenter as the +Supervisor.

+

Currently this list must have a single entry which is the cluster +identifier of the current cluster. This cluster must be a vSAN +cluster and must have vSAN File Service enabled.

+

If a cluster in the list is not a vSAN cluster or does not have +vSAN File Service enabled, an InvalidArgument error will be thrown +from +com.vmware.vcenter.namespace_management_client.Clusters.enable(), +com.vmware.vcenter.namespace_management_client.Clusters.update() +and +com.vmware.vcenter.namespace_management_client.Clusters.set() +APIs.

+

An empty list may be specified to disable file volume support on +the Supervisor.. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource.

+

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.Conditions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Conditions class provides methods to retrieve conditions related to +a particular Supervisor. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Condition(type=None, description=None, status=None, last_transition_time=None, reason=None, severity=None, messages=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Conditions.Condition class defines an observation of the +configuration state of a Supervisor. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (str) – The type of the condition is a CamelCase, machine readable +identifier, indicating the configuration stage. +InfrastructureInitialized, ControlPlaneVMsDeployed and +ControlPlaneVMsConfigured are examples of such identifiers. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the condition type in a human readable format. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • status (Conditions.Condition.Status) – The status of the condition. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • last_transition_time (datetime.datetime or None) – Last time the condition transitioned from one state to another. A +transition happens when the value of status or severity field +changes. This attribute was added in vSphere API 8.0.0.1. +if None, there are no ongoing operations related to bringing the +condition to the desired state.

    • +

  • reason (str) – A brief CamelCase message indicating details about the reason for +the last transition. FailedWithSystemError, +ManagementDNSServersMissing and WaitForNodeUpgrade are examples of +such messages. This attribute was added in vSphere API 8.0.0.1.

    • +

  • severity (Conditions.Severity) – Provides an explicit classification of the reason identifier. Can +be set when the value of status is not TRUE. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • messages (list of Conditions.Message) – A list of human-readable messages that provide additional details +about the last transition. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Status of the condition, which can be one of TRUE, FALSE or UNKNOWN. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+FALSE = Status(string='FALSE')
+

Indicates that the condition has not reached the desired state. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+TRUE = Status(string='TRUE')
+

Indicates that the condition has reached the desired state. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+UNKNOWN = Status(string='UNKNOWN')
+

Indicates that the status of the condition can not be determined. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+ +
+
+class Message(severity=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Conditions.Message class contains user-readable information related +to a Conditions.Condition. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class Severity(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Conditions.Severity class represents the severity of the message. +This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Severity instance.

+
+
+
+
+ERROR = Severity(string='ERROR')
+

Error message. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+INFO = Severity(string='INFO')
+

Informational message. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+WARNING = Severity(string='WARNING')
+

Warning message. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+get(supervisor)
+

Get all conditions of a given Supervisor. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

supervisor (str) – the identifier for a Supervisor. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Return type
+

list of Conditions.Condition

+
+
Returns
+

List of Conditions.Condition objects related to the given +Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if authorization information cannot be retrieved.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor cannot be found, or if the user does not have +read privilege on it.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.ContentLibrarySpec(content_library=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ContentLibrarySpec class contains the specification required to +configure Content Libraries with a Supervisor. This class was added in +vSphere API 8.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

content_library (str) – ContentLibrarySpec.content_library is the Content Library +ID associated with a Supervisor. The Content Library specified +should exist in the vSphere inventory.. This attribute was added in +vSphere API 8.0.2.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library.

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.ControlPlane(network=None, login_banner=None, size=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ControlPlane class describes the control plane configuration. It allows +you to adjust configuration such as size, network, and storage required to +support the control plane runtime.. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network) –

    The management ControlPlane.network is used by vCenter and +the control plane to manage the cluster. vCenter and the NSX (if +used) management plane must be accessible from this network.

    +

    The Supervisor requires that management network traffic is not L3 +routable from workload network traffic.. This attribute was added +in vSphere API 8.0.0.1.

    +

    • +

  • login_banner (str or None) – ControlPlane.login_banner is a disclaimer displayed prior +to login via the Kubectl plugin.. This attribute was added in +vSphere API 8.0.0.1. +If this banner is None, no message will be displayed to users.

    • +

  • size (SizingHint or None) – ControlPlane.size controls the size and resources allocated +to the Kubernetes API server and the worker nodes.. This attribute +was added in vSphere API 8.0.0.1. +Defaults to SMALL.

    • +

  • storage_policy (str or None) – ControlPlane.storage_policy identifies the storage policy +backing the Supervisor Kubernetes API server.. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +This resource is required.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry(hostname=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ImageRegistry class contains the specification required to +configure container image registry endpoint. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hostname (str) – IP address or the hostname of container image registry. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • port (long or None) – Port number of the container image registry. This attribute was +added in vSphere API 8.0.0.1. +If None, defaults to 443.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.ImageSyncConfig(registry=None, repository=None, kubernetes_content_library=None, content_libraries=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

ImageSyncConfig class describes how the Supervisor Cluster and +Kubernetes retrieves VM and container images that will run on the cluster. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • registry (ImageRegistry or None) – The ImageSyncConfig.registry class contains the +specification required to configure container image registry +endpoint. This attribute was added in vSphere API 8.0.0.1. +Defaults to Docker Hub if None.

    • +

  • repository (str or None) –

    The ImageSyncConfig.repository specifies the default +container image repository to use when the Kubernetes Pod +specification does not specify it. For example, hub.docker.com +is the image repository for a Pod whose image specification is +hub.docker.com/nginx.. This attribute was added in vSphere API +8.0.0.1. +If None, and if docker hub is the configured +ImageSyncConfig.registry, then +ImageSyncConfig.repository defaults to Docker Hub. If +Docker Hub is not the configured image registry, +ImageSyncConfig.repository remains unset.

    +

    If {#member} repository is None, you must supply an image +repository in your Pod spec or else images will not be able to be +synced into the cluster.

    +

    • +

  • kubernetes_content_library (str or None) –

    ImageSyncConfig.kubernetes_content_library is the UUID of +the Content Library which holds the VM Images for Tanzu Kubernetes +Service for vSphere.

    +

    This Content Library should be subscribed to VMware’s hosted +vSphere Kubernetes Service Repository. Optionally, you can +configure your own local content library and host images locally.. +This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.content.Library. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: com.vmware.content.Library. +If the Content Library identifier is None, you will not be able to +deploy Tanzu Kubernetes Clusters.

    +

    • +

  • content_libraries (list of ContentLibrarySpec or None) –

    ImageSyncConfig.content_libraries is a list of Content +Libraries that will be associated with a Supervisor.

    +

    This list refers to existing Content Libraries in the vSphere +inventory. These Content Libraries and the Content Library items +belonging to them will be read-only across all vSphere Namespaces. +This list cannot overlap with the +defaultKubernetesServiceContentLibrary.. This attribute was added +in vSphere API 8.0.2.0. +If None, no additional Content Libraries will be set for the +Supervisor apart from the default Kubernetes Service Content +Library.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerOptions(security=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

KubeAPIServerOptions declares options for the Kubernetes API Server.

+

The API server is used to manage workloads on the workload network.. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

security (KubeAPIServerSecurity or None) – KubeAPIServerOptions.security allows you to specify +configuration options for the API server security.. This attribute +was added in vSphere API 8.0.0.1. +If None, default security parameters will be configured.

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerSecurity(certificate_dns_names=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

KubeAPIServerSecurity class declares security options configured on the +Kubernetes API server. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

certificate_dns_names (list of str) –

KubeAPIServerSecurity.certificate_dns_names lists +additional DNS names to associate with the Kubernetes API server.

+

These DNS names are embedded in the TLS certificate presented by +the API server as subject alternative names, which can be used in +conjunction with your DNS server to securely connect a client to +the server.. This attribute was added in vSphere API 8.0.0.1.

+

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.SizingHint(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The SizingHint class determines the configuration of Kubernetes API +server and the worker nodes. It also determines the default values +associated with the maximum number of pods and services. Use +com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get() +to get information associated with a SizingHint. This enumeration was +added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SizingHint instance.

+
+
+
+
+LARGE = SizingHint(string='LARGE')
+

Cluster size of ‘large’. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+MEDIUM = SizingHint(string='MEDIUM')
+

Cluster size of ‘medium’. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SMALL = SizingHint(string='SMALL')
+

Cluster size of ‘small’. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+TINY = SizingHint(string='TINY')
+

Cluster size of ‘tiny’. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.Summary(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Summary class provides methods to retrieve the current states of +Supervisors.

+

Only the basic information of the given Supervisor is being queried.. This +class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ConfigStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Summary.ConfigStatus class describes the status of reaching the +desired state configuration for the Supervisor. This enumeration was added +in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConfigStatus instance.

+
+
+
+
+CONFIGURING = ConfigStatus(string='CONFIGURING')
+

The Namespace configuration is being applied to the Supervisor. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+ERROR = ConfigStatus(string='ERROR')
+

Failed to apply the Namespace configuration to the Supervisor, user +intervention needed. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+REMOVING = ConfigStatus(string='REMOVING')
+

The Namespace configuration is being removed from the Supervisor. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+RUNNING = ConfigStatus(string='RUNNING')
+

The Supervisor is configured correctly with the Namespace configuration. +This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class FilterSpec(config_status=None, kubernetes_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Summary.FilterSpec can be specified to filter summary output by any +allowed criteria. An empty Summary.FilterSpec will cause all results of +the query to be returned. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • config_status (Summary.ConfigStatus or None) – Matches Supervisors with Summary.Info.config_status equal +to the specified value. This attribute was added in vSphere API +8.0.0.1. +if None this filter is not applied.

    • +

  • kubernetes_status (Summary.KubernetesStatus or None) – Matches Supervisors with the Summary.Info.kubernetes_status +equal to the specified value. This attribute was added in vSphere +API 8.0.0.1. +if None this filter is not applied.

    • +
+
+
+
+ +
+
+class Info(name=None, stats=None, config_status=None, kubernetes_status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Summary.Info class contains the basic information about the +statistics and status related to the Supervisor. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – Name of the Supervisor. This attribute was added in vSphere API +8.0.0.1.

    • +

  • stats (Summary.Stats) – Basic runtime statistics for the Supervisor. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • config_status (Summary.ConfigStatus) – Current status of reaching the desired state configuration for the +Supervisor. This attribute was added in vSphere API 8.0.0.1.

    • +

  • kubernetes_status (Summary.KubernetesStatus) – Current Status of the Supervisor’s ability to deploy pods. This +attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class KubernetesStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Summary.KubernetesStatus class describes the Supervisor’s ability +to deploy pods. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the KubernetesStatus instance.

+
+
+
+
+ERROR = KubernetesStatus(string='ERROR')
+

The Supervisor may not be able to accept pods and has error messages. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+READY = KubernetesStatus(string='READY')
+

The Supervisor is able to accept pods. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+WARNING = KubernetesStatus(string='WARNING')
+

The Supervisor may be able to accept pods, but has warning messages. This +class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class ListItem(supervisor=None, info=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Summary.ListItem class contains information about a Supervisor +returned by Summary.list() method. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • supervisor (str) – The immutable identifier of the Supervisor generated during +enablement. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • info (Summary.Info) – The current state of the Supervisor. This attribute was added in +vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class ListResult(items=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Summary.ListResult class represents the result of +Summary.list() method. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

items (list of Summary.ListItem) – List of items. This attribute was added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+class Stats(cpu_used=None, cpu_capacity=None, memory_used=None, memory_capacity=None, storage_used=None, storage_capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Summary.Stats class contains the basic runtime statistics about a +Supervisor. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cpu_used (long) – Overall CPU usage of the Supervisor, in MHz. This is the sum of CPU +usage across all worker nodes in the Supervisor. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • cpu_capacity (long) – Total CPU capacity in the Supervisor, in MHz. This is the sum of +CPU capacities from all worker nodes in the Supervisor. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • memory_used (long) – Overall memory usage of the Supervisor, in mebibytes. This is the +sum of memory usage across all worker nodes in the Supervisor. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • memory_capacity (long) – Total memory capacity of the Supervisor in mebibytes. This is the +sum of memory capacities from all worker nodes in the Supervisor. +This attribute was added in vSphere API 8.0.0.1.

    • +

  • storage_used (long) – Overall storage used by the Supervisor, in mebibytes. This is the +sum of storage used across all worker nodes in the Supervisor. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • storage_capacity (long) – Overall storage capacity of the Supervisor, in mebibytes. This is +the sum of total storage available from all worker nodes in the +Cluster. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+get(supervisor)
+

Queries the current state of the specified Supervisor. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+

supervisor (str) – the identifier for a supervisor +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Return type
+

Summary.Info

+
+
Returns
+

Summary.Info of the Supervisor matching the provided +identifier.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Supervisor matching the ID does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege and the +System.Read privilege on all vSphere Clusters hosting the +Supervisor.

+
+
+
+ +
+
+list(filter=None)
+

Queries the current state of all Supervisors. Optionally, apply the +filter to Supervisors that match the criteria in the +Summary.FilterSpec. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+

filter (Summary.FilterSpec or None) – Set of parameters that can be used to constrain the results of the +method. +if None all records will be returned.

+
+
Return type
+

Summary.ListResult

+
+
Returns
+

ListResult of Summary.Info of all Supervisors matching the +criteria in the Summary.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege and the +System.Read privilege on all vSphere Clusters hosting the +Supervisor.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.Topology(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Topology class provides methods to query the topological layout of +the infrastructure a Supervisor is running on. This class was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(zone=None, clusters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Topology.Info class contains the basic information about the +association between vSphere Zones and vSphere Clusters. This class was +added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • zone (str) – Identifier of this vSphere Zone. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +

  • clusters (list of str) – A list of vSphere Cluster identifiers that are associated with the +vSphere Zone. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource.

    • +
+
+
+
+ +
+
+get(supervisor)
+

Queries the current association between vSphere Zones and vSphere +Clusters from the given Supervisor ID. A Supervisor can be running on +one or multiple vSphere Zones, and each vSphere Zone is associated with +one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from +Topology.get() to call the APIs that requires a vSphere Cluster +ID instead of a Supervisor. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+

supervisor (str) – Identifier for a Supervisor. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Return type
+

list of Topology.Info

+
+
Returns
+

List of Topology.Info of vSphere Zone and vSphere Cluster +associations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if given Supervisor does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have Namespaces.Manage privilege and the +System.Read privilege on all vSphere Clusters hosting the +Supervisor.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.Workloads(network=None, edge=None, kube_api_server_options=None, images=None, storage=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Workloads class describes configuration that affects the behavior and +lifecycle of Kubernetes workloads.. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network) –

    The workloads Workloads.network describes configuration for +the primary workload network.

    +

    Workloads will communicate with each other and will reach external +networks over this network.

    +

    The IP ranges configured on this network are managed primarily +within Kubernetes.. This attribute was added in vSphere API +8.0.0.1.

    +

    • +

  • edge (com.vmware.vcenter.namespace_management.networks.edges_client.Edge) –

    Workloads.edge configuration determines how network traffic +will enter and leave the cluster.

    +

    The IP ranges configured on this network are managed by the +Supervisor and the load balancer.. This attribute was added in +vSphere API 8.0.0.1.

    +

    • +

  • kube_api_server_options (KubeAPIServerOptions or None) – Workloads.kube_api_server_options declares configuration +options for the Kubernetes API Server.. This attribute was added in +vSphere API 8.0.0.1. +If None, the default configuration will be used.

    • +

  • images (ImageSyncConfig or None) – Workloads.images specifies how images will be stored and +pulled into the cluster.. This attribute was added in vSphere API +8.0.0.1. +If None, image sync configuration will default to the settings +described within the ImageSyncConfig class.

    • +

  • storage (WorkloadsStorageConfig or None) – Workloads.storage specifies which persistent storage is +configured and accessible for workloads to consume. You can +configure policies for both images and volumes.. This attribute was +added in vSphere API 8.0.0.1. +If None, configuration will be copied from the control plane when +possible. If not, some storage features may be unavailable.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors_client.WorkloadsStorageConfig(cloud_native_file_volume=None, ephemeral_storage_policy=None, image_storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

WorkloadsStorageConfig class describes how vSphere and Kubernetes will +persist images and volumes to disk. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • cloud_native_file_volume (CNSFileConfig or None) – WorkloadsStorageConfig.cloud_native_file_volume specifies +the Cloud Native Storage file volume support on the Supervisor. +This feature provides ReadWriteMany container volumes support. +This attribute was added in vSphere API 8.0.0.1. +If None, file volume support will not be enabled on the Supervisor.

    • +

  • ephemeral_storage_policy (str or None) – WorkloadsStorageConfig.ephemeral_storage_policy identifies +the storage policy associated with ephemeral disks of all the +Kubernetes PodVMs in the cluster. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +If None during cluster enablement, the ephemeral storage policy +will be defaulted to the configured +ControlPlane.storage_policy.

    • +

  • image_storage_policy (str or None) – The WorkloadsStorageConfig.image_storage_policy class +contains the specification required to configure storage used for +PodVM container images. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +SpsStorageProfile. When methods return a value of this class as +a return value, the attribute will be an identifier for the +resource type: SpsStorageProfile. +If None, the image storage policy will be set to the specified +WorkloadsStorageConfig.ephemeral_storage_policy if +provided. This field will inherit any defaults for ephemeral +storage policy set by the system.

    • +
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.networks.html b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.networks.html new file mode 100644 index 00000000..c5ea693e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.networks.html @@ -0,0 +1,806 @@ + + + + + + + com.vmware.vcenter.namespace_management.networks package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.namespace_management.networks package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.namespace_management.networks.edges_client module

+
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.Edge(id=None, load_balancer_address_ranges=None, haproxy=None, nsx=None, nsx_advanced=None, provider=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Edge class contains configuration for network traffic entering and +exiting a Supervisor. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str or None) – Edge.id is a unique identifier that can be referenced for +updates. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.network.edge.Edge. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.network.edge.Edge. +If unset, an ID will be automatically generated.

    • +

  • load_balancer_address_ranges (list of com.vmware.vcenter.namespace_management.networks_client.IPRange or None) – Edge.load_balancer_address_ranges defines the list of +addresses that a load balancer can consume to publish Kubernetes +services. This range must contain at least one IP address unless +the AVI provider is selected. It is recommended to supply a large +enough range to support load balancers requested for pods in the +control plane and Tanzu Clusters. This attribute was added in +vSphere API 8.0.0.1. +This field must be set if Edge.provider is not an NSX +Advanced Load Balancer,

    • +

  • haproxy (HAProxyConfig) – Edge.haproxy defines configuration for the HAProxy Load +Balancer. This attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of provider is EdgeProvider.HAPROXY.

    • +

  • nsx (NSXConfig) – Edge.nsx defines configuration for the NSX Load Balancer. +This attribute was added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of provider is EdgeProvider.NSX.

    • +

  • nsx_advanced (NSXAdvancedLBConfig) – Edge.nsx_advanced defines configuration for the NSX +Advanced Load Balancer and Ingress Software. This attribute was +added in vSphere API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of provider is EdgeProvider.NSX_ADVANCED.

    • +

  • provider (EdgeProvider or None) – Edge.provider specifies the vendor providing edge services. +This attribute was added in vSphere API 8.0.0.1. +A provider is required to enable edge services for a cluster.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

EdgeProvider describes the supported available edge services. An NSX +edge are used on NSX-T networks, but “Advanced NSX” and HAProxy edges are +used on VDS networks. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EdgeProvider instance.

+
+
+
+
+HAPROXY = EdgeProvider(string='HAPROXY')
+

EdgeProvider.HAPROXY is an HAProxy load balancer fronted by the +Data Plane API. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+NSX = EdgeProvider(string='NSX')
+

EdgeProvider.NSX specifies NSX-T managed edge services. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+NSX_ADVANCED = EdgeProvider(string='NSX_ADVANCED')
+

EdgeProvider.NSX_ADVANCED specifies the NSX Advanced Load Balancer +and Ingress. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.HAProxyConfig(servers=None, username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

HAProxyConfig class describes configuration for the HAProxy Load +Balancer. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of Server) – HAProxyConfig.servers is a list of the addresses for the +data plane API servers used to configure Virtual Servers. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • username (str) – HAProxyConfig.username is used by the HAProxy Kubernetes +Operator to program the HAProxy Controller. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • password (str) – HAProxyConfig.password secures the +HAProxyConfig.username. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • certificate_authority_chain (str) – HAProxyConfig.certificate_authority_chain contains +PEM-encoded CA chain which is used to verify x509 certificates +received from the server. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The LoadBalancerSize class enumerates load balancer sizes supported by +NSX. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LoadBalancerSize instance.

+
+
+
+
+LARGE = LoadBalancerSize(string='LARGE')
+

LoadBalancerSize.LARGE is a load balancer that hosts up to 1000 +virtual servers. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+MEDIUM = LoadBalancerSize(string='MEDIUM')
+

LoadBalancerSize.MEDIUM is a load balancer that hosts up to 100 +virtual servers. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+SMALL = LoadBalancerSize(string='SMALL')
+

LoadBalancerSize.SMALL is a load balancer that hosts up to 20 +virtual servers. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.NSXAdvancedLBConfig(server=None, username=None, password=None, certificate_authority_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NSXAdvancedLBConfig class is used to describe the NSX Advanced Load +Balancer configuration. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server (Server) – NSXAdvancedLBConfig.server is the address for the Avi +Controller, used to configure Virtual Servers. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • username (str) – NSXAdvancedLBConfig.username is used by the AVI Kubernetes +Operator to program the Avi Controller. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • password (str) – NSXAdvancedLBConfig.password is the password for the +username. This attribute was added in vSphere API 8.0.0.1.

    • +

  • certificate_authority_chain (str) – NSXAdvancedLBConfig.certificate_authority_chain contains +PEM-encoded CA chain which is used to verify x509 certificates +received from the server. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.NSXConfig(edge_cluster_id=None, default_ingress_tls_certificate=None, routing_mode=None, egress_ip_ranges=None, t0_gateway=None, load_balancer_size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NSXConfig class describes the configuration for NSX-T Edge services. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • edge_cluster_id (str or None) – NSXConfig.edge_cluster_id defines the NSX Edge Cluster to +be used for Kubernetes Services of type LoadBalancer, Kubernetes +Ingresses, and NSX SNAT. This attribute was added in vSphere API +8.0.0.1. +Defaults to a the edge cluster created earliest.

    • +

  • default_ingress_tls_certificate (str or None) – NSXConfig.default_ingress_tls_certificate defines a default +certificate that is served on Ingress services, when another +certificate is not presented. This configuration applies to all +namespaces by default. This attribute was added in vSphere API +8.0.0.1. +If unset, there will be no certificate served on Ingress.

    • +

  • routing_mode (NSXRoutingMode or None) – NSXConfig.routing_mode enables the network topology in +either NAT mode or Routed Mode. Enabling routed mode will result in +all the workloads i.e vSphere PODs, VMs and Tanzu clusters Node IPs +to be directly accessible from networks beyond the Tier-0 router. +Once a namespace mode is applied, it cannot be changed. This +attribute was added in vSphere API 8.0.0.1. +The default setting is NAT mode.

    • +

  • egress_ip_ranges (list of com.vmware.vcenter.namespace_management.networks_client.IPRange) – NSXConfig.egress_ip_ranges lists the IP Ranges from which +NSX assigns IP addresses used for performing SNAT from container +IPs to external IPs. These ranges must not overlap with other IP +ranges on this network. This attribute was added in vSphere API +8.0.0.1. +If this range is empty, network traffic will not be able to exit +the cluster.

    • +

  • t0_gateway (str or None) – NSXConfig.t0_gateway specifies the default Tier-0 gateway +ID for the namespaces configuration. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXTier0Gateway. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXTier0Gateway. +If unset, the default Tier-0 gateway from the edge cluster is used.

    • +

  • load_balancer_size (LoadBalancerSize or None) – NSXConfig.load_balancer_size describes the load balancer +sizing options available. Larger sizes support more active virtual +servers, but consume more resources. This attribute was added in +vSphere API 8.0.0.1. +If unset, the size defaults to small.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

NSXRoutingMode enum defines an enumeration of available routing modes. +This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NSXRoutingMode instance.

+
+
+
+
+NAT = NSXRoutingMode(string='NAT')
+

NSXRoutingMode.NAT uses network address translation and the +NSXConfig.egress_ip_ranges to route traffic out of the cluster. +This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+ROUTED = NSXRoutingMode(string='ROUTED')
+

NSXRoutingMode.ROUTED configures NSX-T to route directly to Pods +cluster IP addresses. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.Server(host=None, port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A Server class represents an endpoint used to configure load balancers. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – Server.host specifies a the management hostname or IPv4 +address for a load balancer. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • port (long) – Server.port specifies a management port used to access a +load balancer. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.edges_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.networks.nsx_client module

+
+
+class com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DistributedSwitches class provides methods to get the basic +information of Distributed Switches. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(compatible=None, zones=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DistributedSwitches.FilterSpec class contains attributes used to +filter the results when listing Distributed Switches (see +DistributedSwitches.list()). This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatible (bool or None) – Compatibility criteria. If true, only Distributed Switches +compatible with the vSphere Namespaces will be returned. If false, +only Distributed Switches incompatible with the vSphere Namespaces +will be returned. This attribute was added in vSphere API 8.0.0.1. +If None, both compatible and incompatible Distributed Switches will +be returned.

    • +

  • zones (list of str) – Zone compatibility criteria. If zones are specified, the common +distributed switches across the given zones will returned. A +distributed switch is considered common if it is present in all of +the vSphere clusters in a given zone. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.vcenter.consumption_domains.Zone.

    • +
+
+
+
+ +
+
+class Summary(distributed_switch=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DistributedSwitches.Summary class contains the basic information +about a Distributed Switch. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • distributed_switch (str) – Identifier of the switch. The value of this field refers to the +UUID of a vim.DistributedVirtualSwitch. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: vSphereDistributedSwitch.

    • +

  • name (str) – Human-readable identifier of the switch. This attribute was added +in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns basic information of the Distributed Switches matching the +DistributedSwitches.FilterSpec. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

filter (DistributedSwitches.FilterSpec or None) – Specification of matching Distributed Switches for which +information should be returned. +If None, the behavior is equivalent to a +DistributedSwitches.FilterSpec with all attributes None +which means all Distributed Switches will be returned.

+
+
Return type
+

list of DistributedSwitches.Summary

+
+
Returns
+

List of Distributed Switches summaries matching the +DistributedSwitches.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one or more fields of the +DistributedSwitches.FilterSpec is incorrect.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.nsx_client.Edges(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Edges class provides methods to retrieve the basic information for +NSX Edges. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(compatible=None, distributed_switch=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Edges.FilterSpec class contains attributes used to filter the +results when listing Edges (see Edges.list()). This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • compatible (bool or None) – Compatibility criteria. If true, only Edges which are compatible +with vSphere Namespaces will be returned. If false, only Edges +incompatible with vSphere Namespaces will be returned. This +attribute was added in vSphere API 8.0.0.1. +If None, both compatible and incompatible Edges will be returned.

    • +

  • distributed_switch (list of str) – Distributed switch UUID criteria. If distributed switches +identifiers are specified, they will be used to filter the Edges. +To obtain the available distributed switch UUIDs, use: +DistributedSwitches.list(). This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: vSphereDistributedSwitch.

    • +
+
+
+
+ +
+
+class Summary(edge_cluster=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Edges.Summary class contains the basic information about an Edge. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • edge_cluster (str) – Identifier of the Edge. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXEdgeCluster. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXEdgeCluster.

    • +

  • name (str) – Human-readable identifier of the Edge. This attribute was added in +vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns a list of Edges matching the given filter. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+

filter (Edges.FilterSpec or None) – Specification of matching Edges for which information should be +returned. +If None, the behavior is equivalent to a Edges.FilterSpec +with all attributes None which means all Edges will be returned.

+
+
Return type
+

list of Edges.Summary

+
+
Returns
+

List of Edge summaries matching the given filter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one or more fields of the Edges.FilterSpec is +incorrect.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.nsx_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.networks.service_client module

+
+
+class com.vmware.vcenter.namespace_management.networks.service_client.DNS(servers=None, search_domains=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

DNS describes DNS servers and search domains for a given network. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of str) –

    DNS.servers is a list of IP addresses that clients may use +for DNS resolution on a given network in priority order.

    +

    If empty, no DNS servers will be configured.. This attribute was +added in vSphere API 8.0.0.1.

    +

    • +

  • search_domains (list of str) –

    DNS.search_domains is a list of DNS search domains to be +used on this network.

    +

    This field is useful for corporate networks or local domains that +are not publicly resolvable.

    +

    If empty, no search domains will be configured.. This attribute was +added in vSphere API 8.0.0.1.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.service_client.NTP(servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NTP class describes network time protocol configuration for a network. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

servers (list of str) – NTP.servers contains a list of servers in priority order +that clients can use for network time protocol. This attribute was +added in vSphere API 8.0.0.1.

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.networks.service_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.networks.nsx.html b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.networks.nsx.html new file mode 100644 index 00000000..ab49104d --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.networks.nsx.html @@ -0,0 +1,340 @@ + + + + + + + com.vmware.vcenter.namespace_management.networks.nsx package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.namespace_management.networks.nsx package

+
+

Submodules

+
+
+

com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client module

+
+
+class com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Compatibility class provides methods to get Namespaces +compatibility information of Distributed Switches. This class was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Summary(distributed_switch=None, name=None, compatible=None, incompatibility_reasons=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Compatibility.Summary class contains basic and compatibility +information of a Distributed Switch. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • distributed_switch (str) – Identifier of the switch. The value of this field refers to the +UUID of a vim.DistributedVirtualSwitch. This attribute was added in +vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: vSphereDistributedSwitch.

    • +

  • name (str) – Human-readable identifier of the switch. This attribute was added +in vSphere API 8.0.0.1.

    • +

  • compatible (bool) – Compatibility of this Distributed Switch with the vSphere +Namespaces. This attribute was added in vSphere API 8.0.0.1.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – List of reasons for incompatibility. If empty, this Distributed +Switch is compatible. This attribute was added in vSphere API +8.0.0.1.

    • +
+
+
+
+ +
+
+check(filter=None)
+

Returns a list of Distributed Switches matching the given filter and +their compatibility information. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+

filter (com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec or None) – Specification of matching Distributed Switches for which +information should be returned. +If None, the behavior is equivalent to a filter with all attributes +None which means all Distributed Switches and their compatibility +information will be returned.

+
+
Return type
+

list of Compatibility.Summary

+
+
Returns
+

List of Distributed Switches compatibility summaries matching the +given filter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one or more fields of the given filter is incorrect.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.networks.nsx.edges_client module

+
+
+class com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Compatibility class provides methods to retrieve the basic and +Namespaces compatibility information of Edges. This class was added in +vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Summary(edge_cluster=None, name=None, compatible=None, incompatibility_reasons=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Compatibility.Summary class contains information about an Edge, +including whether it is compatible with the vCenter Namespaces feature and +incompatibility reasons. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • edge_cluster (str) – Identifier of the Edge. This attribute was added in vSphere API +8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +NSXEdgeCluster. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: NSXEdgeCluster.

    • +

  • name (str) – User-friendly identifier of the Edge. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • compatible (bool) – Compatibility of this Edge with vSphere Namespaces. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • incompatibility_reasons (list of com.vmware.vapi.std_client.LocalizableMessage) – List of reasons for incompatibility. If empty, this Edge is +compatible. This attribute was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+check(filter=None)
+

Returns a list of Edges matching the given filter and their +compatibility information. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+

filter (com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec or None) – Specification of matching Edges for which information should be +returned. +If None, the behavior is equivalent to a given filter with all +attributes None which means all Edges will be returned.

+
+
Return type
+

list of Compatibility.Summary

+
+
Returns
+

List of Edge compatibility summaries matching the given filter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one or more fields of the given filter is incorrect.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have System.Read privilege.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.networks.nsx.edges_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.supervisors.html b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.supervisors.html new file mode 100644 index 00000000..6671ee3e --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.supervisors.html @@ -0,0 +1,755 @@ + + + + + + + com.vmware.vcenter.namespace_management.supervisors package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.namespace_management.supervisors package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.namespace_management.supervisors.identity_client module

+

The com.vmware.vcenter.namespace_management.supervisors.identity_client +module provides classes related to identity management for a Supervisor.

+
+
+class com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Providers class provides methods to configure identity management +on a Supervisor. This class was added in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(display_name=None, issuer_url=None, username_claim=None, groups_claim=None, client_id=None, client_secret=None, certificate_authority_data=None, additional_scopes=None, additional_authorize_parameters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.CreateSpec class is used to register a new upstream +identity provider for use with a Supervisor. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – A name to be used for the given identity provider. This name will +be displayed in the vCenter UI. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • issuer_url (str) – The URL to the identity provider issuing tokens. The OIDC discovery +URL will be derived from the issuer URL, according to RFC8414: +https://issuerURL/.well-known/openid-configuration. This must use +HTTPS as the scheme. This attribute was added in vSphere API +8.0.0.1.

    • +

  • username_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the username for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, the upstream issuer URL will be concatenated with the +‘sub’ claim to generate the username to be used with Kubernetes.

    • +

  • groups_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the groups for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, no groups will be used from the upstream identity +provider.

    • +

  • client_id (str) – The clientID is the OAuth 2.0 client ID registered in the upstream +identity provider and used by the Supervisor. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • client_secret (str) – The OAuth 2.0 client secret to be used by the Supervisor when +authenticating to the upstream identity provider. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • certificate_authority_data (str or None) – Certificate authority data to be used to establish HTTPS +connections with the identity provider. This must be a PEM-encoded +value. This attribute was added in vSphere API 8.0.0.1. +If None, HTTPS connections with the upstream identity provider will +rely on a default set of system trusted roots.

    • +

  • additional_scopes (list of str or None) – Additional scopes to be requested in tokens issued by this identity +provider. This attribute was added in vSphere API 8.0.0.1. +If None, no additional scopes will be requested.

    • +

  • additional_authorize_parameters ((dict of str and str) or None) – Any additional parameters to be sent to the upstream identity +provider during the authorize request in the OAuth2 authorization +code flow. One use case is to pass in a default tenant ID if you +have a multi-tenant identity provider. For instance, with VMware’s +Cloud Services Platform, if your organization ID is +‘long-form-org-id’, the ‘orgLink’ parameter can be set to +“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging +in to leverage that organization. This attribute was added in +vSphere API 8.0.0.1. +If None, no additional parameters will be sent to the upstream +identity provider.

    • +
+
+
+
+ +
+
+class Info(provider=None, display_name=None, issuer_url=None, username_claim=None, groups_claim=None, client_id=None, certificate_authority_data=None, additional_scopes=None, additional_authorize_parameters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Info class provides details about an identity provider +configured with a Supervisor. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – The immutable identifier of an identity provider generated when an +identity provider is registered for a Supervisor. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

    • +

  • display_name (str) – A name to be used for the given identity provider. This name will +be displayed in the vCenter UI. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • issuer_url (str) –

    The URL to the identity provider issuing tokens. The OIDC discovery +URL will be derived from the issuer URL, according to RFC8414: +https://issuerURL/.well-known/openid-configuration. This must use +HTTPS as the scheme. This attribute was added in vSphere API +8.0.0.1.

    +

    • +

  • username_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the username for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, the upstream issuer URL will be concatenated with the +‘sub’ claim to generate the username to be used with Kubernetes.

    • +

  • groups_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the groups for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, no groups will be used from the upstream identity +provider.

    • +

  • client_id (str) – The clientID is the OAuth 2.0 client ID registered in the upstream +identity provider and used by the Supervisor. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • certificate_authority_data (str or None) – The certificate authority data holds the trusted roots to be used +to establish HTTPS connections with the identity provider. This +attribute was added in vSphere API 8.0.0.1. +If None, HTTPS connections with the upstream identity provider will +rely on a default set of system trusted roots.

    • +

  • additional_scopes (list of str or None) – Additional scopes to be requested in tokens issued by this identity +provider. The ‘openid’ scope will always be requested. This +attribute was added in vSphere API 8.0.0.1. +If None, no additional scopes will be requested.

    • +

  • additional_authorize_parameters ((dict of str and str) or None) – Any additional parameters to be sent to the upstream identity +provider during the authorize request in the OAuth2 authorization +code flow. One use case is to pass in a default tenant ID if you +have a multi-tenant identity provider. For instance, with VMware’s +Cloud Services Platform, if your organization ID is +‘long-form-org-id’, the ‘orgLink’ parameter can be set to +“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging +in to leverage that organization. This attribute was added in +vSphere API 8.0.0.1. +If None, no additional parameters will be sent to the upstream +identity provider.

    • +
+
+
+
+ +
+
+class SetSpec(display_name=None, issuer_url=None, username_claim=None, groups_claim=None, client_id=None, client_secret=None, certificate_authority_data=None, additional_scopes=None, additional_authorize_parameters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.SetSpec class is used to fully replace the configuration +of an upstream identity provider for use with a Supervisor. This class was +added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – A name to be used for the given identity provider. This name will +be displayed in the vCenter UI. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • issuer_url (str) –

    The URL to the identity provider issuing tokens. The OIDC discovery +URL will be derived from the issuer URL, according to RFC8414: +https://issuerURL/.well-known/openid-configuration. This must use +HTTPS as the scheme. This attribute was added in vSphere API +8.0.0.1.

    +

    • +

  • username_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the username for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, the upstream issuer URL will be concatenated with the +‘sub’ claim to generate the username to be used with Kubernetes.

    • +

  • groups_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the groups for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, no groups will be used from the upstream identity +provider.

    • +

  • client_id (str) – The clientID is the OAuth 2.0 client ID registered in the upstream +identity provider and used by the Supervisor. This attribute was +added in vSphere API 8.0.0.1.

    • +

  • client_secret (str) – The OAuth 2.0 client secret to be used by the Supervisor when +authenticating to the upstream identity provider. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • certificate_authority_data (str or None) – Certificate authority data to be used to establish HTTPS +connections with the identity provider. This must be a PEM-encoded +value. This attribute was added in vSphere API 8.0.0.1. +If None, HTTPS connections with the upstream identity provider will +rely on a default set of system trusted roots.

    • +

  • additional_scopes (list of str or None) – Additional scopes to be requested in tokens issued by this identity +provider. This attribute was added in vSphere API 8.0.0.1. +If None, no additional scopes will be requested.

    • +

  • additional_authorize_parameters ((dict of str and str) or None) – Any additional parameters to be sent to the upstream identity +provider during the authorize request in the OAuth2 authorization +code flow. One use case is to pass in a default tenant ID if you +have a multi-tenant identity provider. For instance, with VMware’s +Cloud Services Platform, if your organization ID is +‘long-form-org-id’, the ‘orgLink’ parameter can be set to +“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging +in to leverage that organization. This attribute was added in +vSphere API 8.0.0.1. +If None, no additional parameters will be sent to the upstream +identity provider.

    • +
+
+
+
+ +
+
+class Summary(provider=None, display_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Summary class provides an overview of an identity +provider configured for the given Supervisor. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) – The immutable identifier of an identity provider generated when an +identity provider is registered for a Supervisor. This attribute +was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

    • +

  • display_name (str) – A name to be used for the given identity provider. This name will +be displayed in the vCenter UI. This attribute was added in vSphere +API 8.0.0.1.

    • +
+
+
+
+ +
+
+class UpdateSpec(display_name=None, issuer_url=None, username_claim=None, unset_username_claim=None, groups_claim=None, unset_groups_claim=None, client_id=None, client_secret=None, certificate_authority_data=None, unset_certificate_authority_data=None, additional_scopes=None, additional_authorize_parameters=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.UpdateSpec class contains the specification required to +update the configuration of an identity provider used with a Supervisor. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str or None) – A name to be used for the given identity provider. This name will +be displayed in the vCenter UI. This attribute was added in vSphere +API 8.0.0.1. +if None, the name will remained unchanged.

    • +

  • issuer_url (str or None) –

    The URL to the identity provider issuing tokens. The OIDC discovery +URL will be derived from the issuer URL, according to RFC8414: +https://issuerURL/.well-known/openid-configuration. This must use +HTTPS as the scheme. This attribute was added in vSphere API +8.0.0.1. +If None, the issuer URL will not be updated.

    +

    • +

  • username_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the username for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, the username claim will not be updated.

    • +

  • unset_username_claim (bool or None) – This represents the intent of the change to +Providers.UpdateSpec.username_claim. If this field is set +to true, the existing ‘usernameClaim’ value will be removed. If +this field is set to false, the existing username claim will be +changed to the value specified in +Providers.UpdateSpec.username_claim, if any. This attribute +was added in vSphere API 8.0.0.1. +If None, the existing ‘usernameClaim’ value will be changed to the +value specified in Providers.UpdateSpec.username_claim, if +any.

    • +

  • groups_claim (str or None) – The claim from the upstream identity provider ID token or user info +endpoint to inspect to obtain the groups for the given user. This +attribute was added in vSphere API 8.0.0.1. +If None, the groups claim will not be updated.

    • +

  • unset_groups_claim (bool or None) – This represents the intent of the change to +Providers.UpdateSpec.groups_claim. If this field is set to +true, the existing ‘groupsClaim’ value will be removed. If this +field is set to false, the existing groups claim will be +changed to the value specified in +Providers.UpdateSpec.groups_claim, if any. This attribute +was added in vSphere API 8.0.0.1. +If None, the existing ‘groupsClaim’ value will be changed to the +value specified in Providers.UpdateSpec.groups_claim, if +any.

    • +

  • client_id (str or None) – The clientID is the OAuth 2.0 client ID registered in the upstream +identity provider and used by the Supervisor. This attribute was +added in vSphere API 8.0.0.1. +If None, the client ID will not be updated.

    • +

  • client_secret (str or None) – The OAuth 2.0 client secret to be used by the Supervisor when +authenticating to the upstream identity provider. This attribute +was added in vSphere API 8.0.0.1. +If None, the client secret will not be updated.

    • +

  • certificate_authority_data (str or None) – Certificate authority data to be used to establish HTTPS +connections with the identity provider. This must be a PEM-encoded +value. This attribute was added in vSphere API 8.0.0.1. +If None, the certificate authority data will not be updated.

    • +

  • unset_certificate_authority_data (bool or None) – This represents the intent of the change to +Providers.UpdateSpec.certificate_authority_data. If this +field is set to true, the existing ‘certificateAuthorityData’ +value will be removed. If this field is set to false, the +existing certificate authority data will be changed to the value +specified in +Providers.UpdateSpec.certificate_authority_data, if any. +This attribute was added in vSphere API 8.0.0.1. +If None, the existing ‘certificateAuthorityData’ value will be +changed to the value specified in +Providers.UpdateSpec.certificate_authority_data, if any.

    • +

  • additional_scopes (list of str or None) – Additional scopes to be requested in tokens issued by this identity +provider. This attribute was added in vSphere API 8.0.0.1. +If None, the additional scopes will not be updated.

    • +

  • additional_authorize_parameters ((dict of str and str) or None) – Any additional parameters to be sent to the upstream identity +provider during the authorize request in the OAuth2 authorization +code flow. One use case is to pass in a default tenant ID if you +have a multi-tenant identity provider. For instance, with VMware’s +Cloud Services Platform, if your organization ID is +‘long-form-org-id’, the ‘orgLink’ parameter can be set to +“/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging +in to leverage that organization. This attribute was added in +vSphere API 8.0.0.1. +If None, the additional parameters will not be updated.

    • +
+
+
+
+ +
+
+create(supervisor, spec)
+

Create a new identity provider to be used with a Supervisor. Currently, +only a single identity provider can be created. This method was added +in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – the Supervisor for which the identity provider is being registered. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • spec (Providers.CreateSpec) – the {#link CreateSpec} describing the identity provider to be +registered.

    • +
+
+
Return type
+

str

+
+
Returns
+

a unique identifier for the identity provider that was registered. +The return value will be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the \@{param.name spec} contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the specified Supervisor does not exist, or if an identity +provider is already configured.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is missing the Namespaces.Manage privilege on the +Supervisor.

+
+
+
+ +
+
+delete(supervisor, provider)
+

Remove an identity provider configured with a given Supervisor. This +will result in users no longer being able to log in to either the +Supervisor or any of its workload clusters with that identity provider. +This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – the identifier of the Supervisor which is associated with the +identity provider being removed. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • provider (str) – the identifier for the identity provider that is to be deleted. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the given identity provider or Supervisor cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is missing the Namespaces.Manage privilege on the +Supervisor.

+
+
+
+ +
+
+get(supervisor, provider)
+

Returns information about an identity provider configured for a +Supervisor. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – identifier for the Supervisor for which the identity provider is +being read. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • provider (str) – identifier for the identity provider that is being read. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

    • +
+
+
Return type
+

Providers.Info

+
+
Returns
+

An {#link Info} representing the requested identity provider.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the given identity provider or Supervisor cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is missing the System.Read privilege on the Supervisor.

+
+
+
+ +
+
+list(supervisor)
+

List the identity providers configured for a given Supervisor. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+

supervisor (str) – the Supervisor for which identity providers are being listed. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

+
+
Return type
+

list of Providers.Summary

+
+
Returns
+

A list of {#link Summary} with details about the identity providers +associated with a given Supervisor.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the given Supervisor cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is missing the System.Read privilege on the Supervisor.

+
+
+
+ +
+
+set(supervisor, provider, spec)
+

Update the entire configuration for an existing identity provider used +with a Supervisor. This method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – the identifier for the Supervisor associated with the identity +provider to be updated. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • provider (str) – the identifier for the identity provider that is to be updated. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

    • +

  • spec (Providers.SetSpec) – the {#link SetSpec} to be applied to the identity provider +configuration.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the \@{param.name spec} contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the given identity provider or Supervisor cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is missing the Namespaces.Manage privilege on the +Supervisor.

+
+
+
+ +
+
+update(supervisor, provider, spec)
+

Update an existing identity provider used with a Supervisor. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • supervisor (str) – the identifier for the Supervisor associated with the identity +provider to be updated. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.supervisor.Supervisor.

    • +

  • provider (str) – the identifier for the identity provider that is to be updated. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.identity.Provider.

    • +

  • spec (Providers.UpdateSpec) – the {#UpdateSpec} to be applied to the identity provider +configuration.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the \@{param.name spec} contains any errors.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the given identity provider or Supervisor cannot be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user is missing the Namespaces.Manage privilege on the +Supervisor.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.identity_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.supervisors.networks.html b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.supervisors.networks.html new file mode 100644 index 00000000..f40d716a --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.namespace_management.supervisors.networks.html @@ -0,0 +1,550 @@ + + + + + + + com.vmware.vcenter.namespace_management.supervisors.networks package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.namespace_management.supervisors.networks package

+
+

Submodules

+
+
+

com.vmware.vcenter.namespace_management.supervisors.networks.management_client module

+
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network(network=None, backing=None, services=None, ip_management=None, floating_ip_address=None, proxy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Network class represents configuration for a network used to manage the +Supervisor control plane. vCenter and, if used, NSX Manager and/or external +Load Balancers, etc. should be reachable on this network.. This class was +added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (str or None) – Network.network is a unique identifier for this network +which can be referenced later for updates or queries.. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network. +If unset, an ID will be generated.

    • +

  • backing (NetworkBacking) – Network.backing specifies the network backing to use as the +uplink to the management network.. This attribute was added in +vSphere API 8.0.0.1.

    • +

  • services (com.vmware.vcenter.namespace_management.networks_client.Services or None) – Network.services specifies which network services are +configured on this network. These network services are expected to +be accessible via the associated distributed virtual port group or +distributed virtual switch.. This attribute was added in vSphere +API 8.0.0.1. +If unset, network services may be automatically configured. If you +want to disable any configuration of network services, explicitly +set this class to empty.

    • +

  • ip_management (com.vmware.vcenter.namespace_management.networks_client.IPManagement or None) – Network.ip_management describes how IP addressing is +configured on this network.. This attribute was added in vSphere +API 8.0.0.1. +If unset, this network becomes a DHCP network. Your DHCP server +must support client identifiers to successfully enable a +Supervisor.

    • +

  • floating_ip_address (str or None) – Network.floating_ip_address is an IP address that provides +a stable endpoint to the control plane. This address if specified +must be an unused statically allocated IP address on the management +network.. This attribute was added in vSphere API 8.0.0.1. +If None and the management network is a static network, this +address should be allocated in a static IP configuration which +occurs when +com.vmware.vcenter.namespace_management.networks_client.IPManagement.dhcp_enabled +is set to false. If None and the management network is a DHCP +network, The Supervisor will attempt to use the DHCP server to +allocate this address. You should ensure the DHCP server is +configured to persist IP addresses indefinitely using client +identifiers if this configuration is used.

    • +

  • proxy (ProxyConfiguration or None) – Proxy configuration will be applied to the Supervisor. The proxy +should be reachable from the management network and will be used +for image pulling and container traffic exiting out of the +Supervisor.. This attribute was added in vSphere API 8.0.0.1. +If None the settings will be inherited from the vCenter settings if +available.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking(backing=None, network=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

A NetworkBacking enumerates the possible options for uplinking to a +Supervisor management network.. This class was added in vSphere API +8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing (NetworkBackingEnum) – Selects the backing used for a management network.. This attribute +was added in vSphere API 8.0.0.1.

    • +

  • network (str) – The Managed Object ID of the Network object.. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network. +This attribute is optional and it is only relevant when the value +of backing is NetworkBackingEnum.NETWORK.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

NetworkBackingEnum enumerates types of network backings supported by +the Supervisor for the management network.. This enumeration was added in +vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkBackingEnum instance.

+
+
+
+
+NETWORK = NetworkBackingEnum(string='NETWORK')
+

Indicates a virtual infrastructure management Network. It may include items +like opaque networks or Distributed Virtual Port Groups.. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration(proxy_settings_source=None, https_proxy_config=None, http_proxy_config=None, no_proxy_config=None, tls_root_ca_bundle=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ProxyConfiguration class defines proxy configuration to be used by +the Supervisor.. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • proxy_settings_source (ProxySettingsSource) –

    The source of the proxy settings.

    +

    If ProxySettingsSource.VC_INHERITED or +ProxySettingsSource.NONE is specified, then the other +configuration in ProxyConfiguration will be ignored.. This +attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • https_proxy_config (str or None) –

    HTTPS proxy configuration. Examples:

    + +

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED +is used for the source, otherwise this will be ignored.. This +attribute was added in vSphere API 8.0.0.1. +If None no HTTPS proxy will be used.

    +

    • +

  • http_proxy_config (str or None) –

    HTTP proxy configuration. Examples:

    + +

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED +is used for the source, otherwise this will be ignored.. This +attribute was added in vSphere API 8.0.0.1. +If None no HTTP proxy will be used.

    +

    • +

  • no_proxy_config (list of str or None) –

    List of addresses that should be accessed directly.

    +

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED +is used for the source, otherwise this will be ignored.. This +attribute was added in vSphere API 8.0.0.1. +If None there won’t be any excluded addresses.

    +

    • +

  • tls_root_ca_bundle (str or None) –

    Proxy TLS root CA bundle which will be used to verify the proxy’s +certificates. Every certificate in the bundle is expected to be in +PEM format.

    +

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED +is used for the source, otherwise this will be ignored.. This +attribute was added in vSphere API 8.0.0.1. +If None only the vCenter certificates applied in VECS (VMware +Endpoint Certificate Store) will be used.

    +

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The settings can be inherited from the vCenter settings, so the Supervisor +settings will be synced. The settings can be applied directly on the +Supervisor level, or the Supervisor can be configured not to use a proxy.. +This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ProxySettingsSource instance.

+
+
+
+
+CLUSTER_CONFIGURED = ProxySettingsSource(string='CLUSTER_CONFIGURED')
+

Proxy settings will be configured at the Supervisor level. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+NONE = ProxySettingsSource(string='NONE')
+

No proxy settings will be applied to the Supervisor. This class attribute +was added in vSphere API 8.0.0.1.

+
+ +
+
+VC_INHERITED = ProxySettingsSource(string='VC_INHERITED')
+

Proxy settings will be inherited from the vCenter settings. vCenter and +Supervisor settings will be kept in sync.. This class attribute was added +in vSphere API 8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.namespace_management.supervisors.networks.workload_client module

+
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network(network=None, network_type=None, nsx=None, vsphere=None, services=None, ip_management=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Network class represents configuration for a network running workloads +on a Supervisor.. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (str or None) – Network.network is a unique identifier for this network +which can be referenced later for updates or queries.. This +attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.namespace_management.Network. +If unset, an ID will be generated.

    • +

  • network_type (NetworkType) – Network.network_type describes the type of network.. This +attribute was added in vSphere API 8.0.0.1.

    • +

  • nsx (NsxNetwork) – Network.nsx specifies network configuration that is +specific to NSX-T networks.. This attribute was added in vSphere +API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of networkType is NetworkType.NSXT.

    • +

  • vsphere (VSphereNetwork) – Network.vsphere specifies network configuration that is +specific to vSphere networks.. This attribute was added in vSphere +API 8.0.0.1. +This attribute is optional and it is only relevant when the value +of networkType is NetworkType.VSPHERE.

    • +

  • services (com.vmware.vcenter.namespace_management.networks_client.Services or None) – Network.services specifies which network services are +configured on this network. These network services are expected to +be accessible via the associated distributed virtual port group or +distributed virtual switch.. This attribute was added in vSphere +API 8.0.0.1. +If unset, network services may be automatically configured. If you +want to disable any configuration of network services, explicitly +set this class to empty.

    • +

  • ip_management (com.vmware.vcenter.namespace_management.networks_client.IPManagement or None) – Network.ip_management describes how IP addressing is +configured on this network.. This attribute was added in vSphere +API 8.0.0.1. +If unset, this network becomes a DHCP network. Your DHCP server +must support client identifiers to successfully enable a +Supervisor.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

NetworkType enumerates types of networks supported by the Supervisor +for workloads.. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkType instance.

+
+
+
+
+NSXT = NetworkType(string='NSXT')
+

Indicates an NSX-T backed network.. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+VSPHERE = NetworkType(string='VSPHERE')
+

Indicates vSphere Networking.. This class attribute was added in vSphere +API 8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork(dvs=None, namespace_subnet_prefix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

NsxNetwork specifies network backing configuration that is specific to +the workload network.. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dvs (str) – NsxNetwork.dvs is the Managed Object ID of a vSphere +Distributed Virtual Switch. You can use it to connect to an NSX-T +Network.. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedSwitch. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: vSphereDistributedSwitch.

    • +

  • namespace_subnet_prefix (long or None) – NsxNetwork.namespace_subnet_prefix indicates the size of +the subnet reserved for namespace segments.. This attribute was +added in vSphere API 8.0.0.1. +Defaults to /28.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork(dvpg=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

VSphereNetwork specifies workload network configuration that is +specific to vSphere networks.. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

dvpg (str) – VSphereNetwork.dvpg is the Managed Object ID of a vSphere +Distributed Virtual Port Group. You can use it to connect to a +vSphere Network.. This attribute was added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +vSphereDistributedPortGroup. When methods return a value of +this class as a return value, the attribute will be an identifier +for the resource type: vSphereDistributedPortGroup.

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.namespaces.html b/vsphere/8.0.2.0/com.vmware.vcenter.namespaces.html new file mode 100644 index 00000000..c7fdb2e1 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.namespaces.html @@ -0,0 +1,254 @@ + + + + + + + com.vmware.vcenter.namespaces package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.namespaces package

+
+

Submodules

+
+
+

com.vmware.vcenter.namespaces.user_client module

+

The com.vmware.vcenter.namespaces.user_client module provides classes to +access namespaces for non-administrative users.

+
+
+class com.vmware.vcenter.namespaces.user_client.Instances(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Instances class provides methods to access namespaces for +non-administrative users.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(username=None, groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.FilterSpec class contains attributes used to filter the +results when listing user namespaces (see Instances.list()). This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • username (str or None) – Identifier of the user. This attribute was added in vSphere API +8.0.0.1. +If set, only return namespaces the given user has +permissions to access. If None, this filter is not applied.

    • +

  • groups (list of str or None) – List of group names. This attribute was added in vSphere API +8.0.0.1. +If set, only return namespaces that are associated with +the given group(s). If None, this filter is not applied.

    • +
+
+
+
+ +
+
+class Summary(namespace=None, master_host=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Instances.Summary class contains information about a namespace that +user is authorized to access.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • namespace (str) – Identifier of the namespace. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.namespaces.Instance. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.namespaces.Instance.

    • +

  • master_host (str) – IP address or FQDN of the API endpoint for the given namespace.

    • +
+
+
+
+ +
+
+list(filter=None)
+

Returns namespaces matching the Instances.FilterSpec.

+
+
Parameters
+

filter (Instances.FilterSpec or None) – Specification of matching principals for which namespaces should be +returned. This parameter was added in vSphere API 8.0.0.1. +If None, the behavior is equivalent to a FilterSpec with all +attributes None, and this method will return the namespaces that +user making the call is authorized to access.

+
+
Return type
+

list of Instances.Summary

+
+
Returns
+

List of Namespace identifiers together with the API endpoint for +each namespace.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user does not have Namespaces.ListAccess privilege to +perform this operation.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.namespaces.user_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.storage.html b/vsphere/8.0.2.0/com.vmware.vcenter.storage.html new file mode 100644 index 00000000..d5ba67f4 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.storage.html @@ -0,0 +1,435 @@ + + + + + + + com.vmware.vcenter.storage package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.storage package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.storage.policies_client module

+
+
+class com.vmware.vcenter.storage.policies_client.Compliance(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Compliance class provides methods related to all the associated +entities of given compliance statuses. This class was added in vSphere API +6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Compliance.FilterSpec class contains complianceStatus used to +filter the results when listing entities (see Compliance.list()). +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

status (set of Compliance.Status) – Compliance Status that a virtual machine must have to match the +filter. This attribute was added in vSphere API 6.7.

+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

This enumeration defines the set of status values for a compliance +operation. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+COMPLIANT = Status(string='COMPLIANT')
+

Entity is in compliance. This class attribute was added in vSphere API 6.7.

+
+ +
+
+NON_COMPLIANT = Status(string='NON_COMPLIANT')
+

Entity is out of compliance. This class attribute was added in vSphere API +6.7.

+
+ +
+
+NOT_APPLICABLE = Status(string='NOT_APPLICABLE')
+

Compliance computation is not applicable for this entity because it does +not have any storage requirement that apply to the object-based datastore +on which the entity is placed. This class attribute was added in vSphere +API 6.7.

+
+ +
+
+OUT_OF_DATE = Status(string='OUT_OF_DATE')
+

Compliance status becomes out of date when the profile associated with the +entity is edited and not applied. The compliance status will remain out of +date until the latest policy is applied to the entity. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+UNKNOWN = Status(string='UNKNOWN')
+

Compliance status of the entity is not known. This class attribute was +added in vSphere API 6.7.

+
+ +
+ +
+
+class Summary(vm=None, vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provides the details of a virtual machine and its associated entities which +match the given compliance statuses. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm (str) – Identifier of virtual machine. This attribute was added in vSphere +API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: VirtualMachine.

    • +

  • vm_home (Compliance.Status or None) – Compliance status of the virtual machine home. This attribute was +added in vSphere API 6.7. +If None or empty, vmHome is not associated with a storage policy.

    • +

  • disks ((dict of str and Compliance.Status) or None) – List of the virtual hard disk. This attribute was added in vSphere +API 6.7. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None or empty, virtual machine entity does not have any disks or +its disks are not associated with a storage policy.

    • +
+
+
+
+ +
+
+list(filter)
+

Returns compliance information about entities matching the filter +Compliance.FilterSpec. Entities without storage policy +association are not returned. This method was added in vSphere API 6.7.

+
+
Parameters
+

filter (Compliance.FilterSpec) – compliance status of matching entities for which information should +be returned.

+
+
Return type
+

list of Compliance.Summary

+
+
Returns
+

compliance information about entities matching the filter +Compliance.FilterSpec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Compliance.FilterSpec.status attribute contains a +value that is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.storage.policies_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.storage.policies_client.VM(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The VM class provides methods managing the storage policy association +for a virtual machine and its virtual disks. This class was added in +vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.Info class contains information about a virtual machine and its +virtual disks that are associated with the given storage policy. This class +was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_home (bool) – Flag to indicate whether or not the virtual machine home is +associated with the given storage policy. This attribute was added +in vSphere API 6.7.

    • +

  • disks (list of str) – List of the virtual disks that are associated with the given +storage policy. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +
+
+
+
+ +
+
+list(policy)
+

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.

+
+
Parameters
+

policy (str) – storage policy identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy.

+
+
Return type
+

dict of str and VM.Info

+
+
Returns
+

Information about the virtual machines and/or their virtual disks +that are associated with the given storage policy. +The key in the return value dict will be an identifier for +the resource type: VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no policy associated with policy in the system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if more than 1000 virtual machines are associated with the +specified policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service necessary to +complete the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the backend server encounters some an error while processing the +request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required priveleges.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.storage.policies.html b/vsphere/8.0.2.0/com.vmware.vcenter.storage.policies.html new file mode 100644 index 00000000..18459986 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.storage.policies.html @@ -0,0 +1,348 @@ + + + + + + + com.vmware.vcenter.storage.policies package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.storage.policies package

+
+

Submodules

+
+
+

com.vmware.vcenter.storage.policies.compliance_client module

+
+
+class com.vmware.vcenter.storage.policies.compliance_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.storage.policies.compliance_client.VM(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The VM class provides methods related to query virtual machines of +given compliance statuses. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(status=None, vms=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The VM.FilterSpec class contains Status used to filter the results when +listing virtual machines (see VM.list()). This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (set of VM.Status) – Compliance Status that a virtual machine must have to match the +filter. Atleast one status must be specified. This attribute was +added in vSphere API 6.7.

    • +

  • vms (set of str or None) – Identifiers of virtual machines that can match the filter. This +attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: VirtualMachine. +If None or empty, virtual machines with any identifier matches the +filter

    • +
+
+
+
+ +
+
+class Info(vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Provides the compliance details of a virtual machine and its associated +entities which match the given compliance statuses. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_home (VM.Status or None) – Compliance status of the virtual machine home. This attribute was +added in vSphere API 6.7. +If None or empty, virtual machine home is not associated with a +storage policy.

    • +

  • disks (dict of str and VM.Status) – A Map of virtual disks and their compliance status If empty, the +virtual machine does not have any disks or its disks are not +associated with a storage policy. This attribute was added in +vSphere API 6.7. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +
+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The {\@Status} class defines he valid compliance status values for a +virtual machine or virtual disk. This enumeration was added in vSphere API +6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+COMPLIANT = Status(string='COMPLIANT')
+

The virtual machine or virtual disk is in compliance. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+NON_COMPLIANT = Status(string='NON_COMPLIANT')
+

The virtual machine or virtual disk is in not in compliance. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+NOT_APPLICABLE = Status(string='NOT_APPLICABLE')
+

Compliance computation is not applicable for this virtual machine or disk +because it does not have any storage requirement that apply to the +object-based datastore on which the entity is placed. This class attribute +was added in vSphere API 6.7.

+
+ +
+
+OUT_OF_DATE = Status(string='OUT_OF_DATE')
+

Compliance status becomes out of date when the profile associated with the +virtual machine or disk is edited and not applied. The compliance status +will remain out of date until the latest policy is applied. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+UNKNOWN_COMPLIANCE = Status(string='UNKNOWN_COMPLIANCE')
+

Compliance status of the virtual machine or virtual disk is not known. This +class attribute was added in vSphere API 6.7.

+
+ +
+ +
+
+list(filter)
+

Returns compliance information about at most 1000 virtual machines +matching the filter VM.FilterSpec. If there are no virtual +machines matching the VM.FilterSpec an empty List is returned. +Virtual machines without storage policy association are not returned. +This method was added in vSphere API 6.7.

+
+
Parameters
+

filter (VM.FilterSpec) – compliance status of matching virtual machines for which +information should be returned.

+
+
Return type
+

dict of str and VM.Info

+
+
Returns
+

compliance information about virtual machines matching the filter +VM.FilterSpec. +The key in the return value dict will be an identifier for +the resource type: VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the VM.FilterSpec.status attribute contains a value that +is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the API is invoked against vCenter Server version is less than +6.5

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +If more than 1000 results match the VM.FilterSpec

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.system_config.features.html b/vsphere/8.0.2.0/com.vmware.vcenter.system_config.features.html new file mode 100644 index 00000000..d0de7375 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.system_config.features.html @@ -0,0 +1,153 @@ + + + + + + + com.vmware.vcenter.system_config.features package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.system_config.features package

+
+

Submodules

+
+
+

com.vmware.vcenter.system_config.features.tech_preview_client module

+

The {\@name com.vmware.vcenter.system-config.features.tech_preview} module +provides classes for managing the status of Tech Preview features on the +appliance.

+
+
+class com.vmware.vcenter.system_config.features.tech_preview_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.system_config.html b/vsphere/8.0.2.0/com.vmware.vcenter.system_config.html new file mode 100644 index 00000000..dd900d0d --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.system_config.html @@ -0,0 +1,143 @@ + + + + + + + com.vmware.vcenter.system_config package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.system_config package

+
+

Subpackages

+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html new file mode 100644 index 00000000..7f95c1b5 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html @@ -0,0 +1,834 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.hosts.hardware package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.hosts.hardware package

+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client module

+

The com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client +module provides classes to manage Trusted Platform Modules (TPMs).

+
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EndorsementKeys interface provides methods to get the Trusted +Platform Module (TPM) Endorsement Key (EK) on a host. This class was added +in vSphere API 8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(types=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.FilterSpec class contains attributes used to filter +the results when listing the endorsement key. This class was added in +vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

types (set of EndorsementKeys.Type or None) – Type of the endorsement key. This attribute was added in vSphere +API 8.0.0.1. +if None or empty, the result will not be filtered by types.

+
+
+
+ +
+
+class Info(type=None, public_area=None, name=None, qualified_name=None, public_key=None, certificate=None, manufacturer_certificate_uri=None, manufacturer_certificates=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.Info class contains information that describes a +TPM endorsement key. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (EndorsementKeys.Type) – The TPM endorsement key type. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • public_area (str) –

    The TPM endorsement key public area.

    +

    The public area is a TPM2B_PUBLIC structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 12.2.5 +TPM2B_PUBLIC. This attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • name (str) –

    The TPM endorsement key name.

    +

    The name is a TPM2B_NAME structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 10.5.3 +TPM2B_NAME. This attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • qualified_name (str) –

    The TPM endorsement key qualified name.

    +

    The qualified name is a TPM2B_NAME structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 10.5.3 +TPM2B_NAME. This attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • public_key (str or None) – The TPM public endorsement key in PEM format. This attribute was +added in vSphere API 8.0.0.1. +if None, the PEM format public key could not be determined.

    • +

  • certificate (str or None) – The TPM endorsement key certificate in PEM format. This attribute +was added in vSphere API 8.0.0.1. +if None, the certificate cannot be retrieved from the TPM.

    • +

  • manufacturer_certificate_uri (str or None) – The TPM endorsement key issuer URL extracted from the TPM +endorsement key certificate. This attribute was added in vSphere +API 8.0.0.1. +if None, the URI cannot be retrieved from the endorsement key +certificate.

    • +

  • manufacturer_certificates (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain or None) –

    The TPM manufacturer’s endorsement key certificate chain.

    +

    Endorsement key certificates are signed by the TPM manufacturer. +When available, the manufacturerCertificates attribute will +contain the TPM manufacturer’s endorsement key certificate chain.. +This attribute was added in vSphere API 8.0.0.1. +if None, the certificate chain is not available.

    +

    • +
+
+
+
+ +
+
+class PolicyPcrSpec(pcrs=None, pcr_digest=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.PolicyPcrSpec class contains information that can +be used to construct a PCR policy session for unsealing a secret using the +EndorsementKeys.unseal() operation. This class was added in vSphere +API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • pcrs (str) –

    The PCRs to which the data is sealed.

    +

    The PCR selection is a TPML_PCR_SELECTION structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 10.9.7 +TPML_PCR_SELECTION. This attribute was added in vSphere API +8.0.0.1.

    +

    • +

  • pcr_digest (str or None) –

    The digest of the PCRs selected in +EndorsementKeys.PolicyPcrSpec.pcrs.

    +

    The digest is a TPM2B_DIGEST structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 10.4.2 +TPM2B_DIGEST. This attribute was added in vSphere API 8.0.0.1. +If None, then the PCR digest is calculated by the service based on +the current PCR state.

    +

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey'
+

Resource type for TPM endorsement Key. This class attribute was added in +vSphere API 8.0.0.1.

+
+ +
+
+class Summary(key=None, type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.Summary class contains information that describes a +TPM endorsement key. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • key (str) – A unique identifier for the TPM endorsement key. This attribute was +added in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey.

    • +

  • type (EndorsementKeys.Type) – The TPM endorsement key type. This attribute was added in vSphere +API 8.0.0.1.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The EndorsementKeys.Type class defines the endorsement key type based +on key algorithms. This enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+ECC_NIST_P_256 = Type(string='ECC_NIST_P_256')
+

The ECC NISTP-256 bit key. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+RSA_2048 = Type(string='RSA_2048')
+

The RSA 2048 bit key. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+
+class UnsealSpec(public_area=None, private_area=None, seed=None, policy_pcr=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.UnsealSpec class contains information that +describes the structures required to unseal a secret. This class was added +in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • public_area (str) –

    The public area which corresponding to the +EndorsementKeys.UnsealSpec.private_area secret that is +being unsealed.

    +

    The public area is a TPM2B_PUBLIC structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 12.2.5 +TPM2B_PUBLIC

    +

    This public area is used as the “objectPublic” input to the +TPM2_Import command.

    +

    Trusted Platform Module Library Part 3: Commands, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 13.3 +TPM2_Import. This attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • private_area (str) –

    A private area that contains a secret to be unsealed.

    +

    The private area is symmetrically encrypted with the seed value +derived from EndorsementKeys.UnsealSpec.seed.

    +

    The private area is a TPM2B_PRIVATE structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 12.3.7 +TPM2B_PRIVATE

    +

    This private area is used as the “duplicate” input to the +TPM2_Import command.

    +

    Trusted Platform Module Library Part 3: Commands, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 13.3 +TPM2_Import. This attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • seed (str) –

    A seed value that is encrypted by the TPM endorsement key.

    +

    The seed will be decrypted with the endorsement key and then will +be used as a symmetric key to decrypt +EndorsementKeys.UnsealSpec.private_area. This ensures that +only a TPM with the expected endorsement key can unseal the secret.

    +

    The seed value is a TPM2B_ENCRYPTED_SECRET structure.

    +

    Trusted Platform Module Library Part 2: Structures, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 11.4.3 +TPM2B_ENCRYPTED_SECRET

    +

    This seed is used as the “inSymSeed” input to the TPM2_Import +command.

    +

    Trusted Platform Module Library Part 3: Commands, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 13.3 +TPM2_Import. This attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • policy_pcr (EndorsementKeys.PolicyPcrSpec or None) –

    PCR policy required to unseal the secret.

    +

    Used as input to the TPM2_PolicyPCR command on a session that is +created for issuing the TPM2_Unseal command.

    +

    Trusted Platform Module Library Part 3: Commands, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 23.7 +TPM2_PolicyPCR. This attribute was added in vSphere API 8.0.0.1. +If None, then a zeroed authorization policy is used for the +TPM2_Unseal session.

    +

    • +
+
+
+
+ +
+
+get(host, tpm, key)
+

Get the TPM endorsement key details on a host.

+

The information returned is derived from executing the TPM2_ReadPublic +command on the endorsement key object handle.

+

Trusted Platform Module Library Part 3: Commands, Family “2.0”, Level +00 Revision 01.59, November 8, 2019, Section 12.4 TPM2_ReadPublic. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • tpm (str) – the TPM identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

    • +

  • key (str) – the endorsement key identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey.

    • +
+
+
Return type
+

EndorsementKeys.Info

+
+
Returns
+

The endorsement key info.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the endorsement key, or the TPM device, or the host is not +found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if too many requests are in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Tpm.Read.

    • +
+
+
+
+ +
+
+list(host, tpm, filter=None)
+

Return a list of configured endorsement keys on a host. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • tpm (str) – the TPM identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

    • +

  • filter (EndorsementKeys.FilterSpec or None) – a filter for the returned list. +if {\@term.unset}, the behavior is equivalent to a +EndorsementKeys.FilterSpec with attributes None.

    • +
+
+
Return type
+

list of EndorsementKeys.Summary

+
+
Returns
+

A list of configured endorsement keys.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the TPM device, or the host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if too many requests are in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Tpm.Read.

    • +
+
+
+
+ +
+
+unseal(host, tpm, key, spec)
+

Unseal a secret that is bound to an endorsement key.

+

Provided with duplicate key data, load the key as a child of the +specified endorsement key using the TPM2_Import command and then unseal +the secret data using the TPM2_Unseal command.

+

The duplicate key must include only outer wrapping; inner wrapping is +not supported. The duplicate key cannot have a complex authorization +policy (e.g. including command selection, locality, etc). Only PCR +policy authorization is supported at this time.

+

Trusted Platform Module Library Part 1: Architecture, Family “2.0”, +Level 00 Revision 01.59, November 8, 2019, Section 23.3 Duplication

+

Trusted Platform Module Library Part 3: Commands, Family “2.0”, Level +00 Revision 01.59, November 8, 2019, Section 13.3 TPM2_Import

+

Trusted Platform Module Library Part 3: Commands, Family “2.0”, Level +00 Revision 01.59, November 8, 2019, Section 12.7 TPM2_Unseal. This +method was added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • tpm (str) – the TPM identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

    • +

  • key (str) – the endorsement key identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey.

    • +

  • spec (EndorsementKeys.UnsealSpec) – the unseal spec.

    • +
+
+
Return type
+

str

+
+
Returns
+

The unsealed secret.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the arguments are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the endorsement key or TPM is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if too many requests are in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Tpm.Unseal.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EventLog interface provides methods to get the Trusted Platform +Module (TPM) event log on a host. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(type=None, data=None, truncated=None, banks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EventLog.Info class contains information that describes an event +log. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (EventLog.Type) – Type of the event log. This attribute was added in vSphere API +8.0.0.1.

    • +

  • data (str or None) – Event log data in the format described by +EventLog.Info.type. This attribute was added in vSphere API +8.0.0.1. +This attribute is currently required. It may be optional in a +future version.

    • +

  • truncated (bool) –

    Indicates if the event log is truncated.

    +

    An event log is truncated when there was insufficient memory to +store one or more event entries.. This attribute was added in +vSphere API 8.0.0.1.

    +

    • +

  • banks (list of PcrBank) – The resulting PCR banks from event log replay. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The EventLog.Type class lists the event log types. This enumeration was +added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 = Type(string='EFI_TCG2_EVENT_LOG_FORMAT_TCG_2')
+

TCG EFI Protocol Specification, Family “2.0”, Level 00 Revision 00.13, +March 30, 2016, Section 5.2 Crypto Agile Log Entry Format. This class +attribute was added in vSphere API 8.0.0.1.

+
+ +
+ +
+
+get(host, tpm)
+

Retrieves the event log associated with the TPM device. This method was +added in vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • tpm (str) – the TPM identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

    • +
+
+
Return type
+

EventLog.Info

+
+
Returns
+

The event information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the argument is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if event log is not found, or tpm is not found or host is not +found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if too many requests are in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Tpm.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The HashAlgorithm class defines the possible hash algorithms. This +enumeration was added in vSphere API 8.0.0.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HashAlgorithm instance.

+
+
+
+
+SHA256 = HashAlgorithm(string='SHA256')
+

The SHA 256 hash algorithm. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SHA384 = HashAlgorithm(string='SHA384')
+

The SHA 384 hash algorithm. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SHA512 = HashAlgorithm(string='SHA512')
+

The SHA 512 hash algorithm. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+
+SM3_256 = HashAlgorithm(string='SM3_256')
+

The SM3 hash algorithm. This class attribute was added in vSphere API +8.0.0.1.

+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank(algorithm=None, pcrs=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The PcrBank class contains information that describes digest +information of a PCR bank. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • algorithm (HashAlgorithm) – The hash algorithm that is used by TPM to calculate the PCR values. +This attribute was added in vSphere API 8.0.0.1.

    • +

  • pcrs (dict of long and str) – The index of PCR and corresponding TPM digest value. This attribute +was added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.hosts.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.hosts.html new file mode 100644 index 00000000..117301ac --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.hosts.html @@ -0,0 +1,395 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.hosts package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.hosts package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client module

+

The com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client module +provides classes to manage trusted hardware.

+
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Tpm interface provides methods to get available Trusted Platform +Module (TPM) information on a host. This class was added in vSphere API +8.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(major_versions=None, active=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tpm.FilterSpec class contains attributes used to filter the results +when listing configured TPMs. This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • major_versions (set of long or None) – The TPM major version number. This attribute was added in vSphere +API 8.0.0.1. +if None or empty, the result will not be filtered by version +number.

    • +

  • active (bool or None) – The TPM status. This attribute was added in vSphere API 8.0.0.1. +if None, the result will not be filtered by status.

    • +
+
+
+
+ +
+
+class Info(major_version=None, minor_version=None, active=None, manufacturer=None, model=None, firmware_version=None, banks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tpm.Info class contains information that describes a TPM device. +This class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • major_version (long) – The TPM major version number. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • minor_version (long) – The TPM minor version number. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • active (bool) –

    The TPM status.

    +

    Inactive TPMs cannot be used for sealing or attestation.. This +attribute was added in vSphere API 8.0.0.1.

    +

    • +

  • manufacturer (str or None) – The TPM manufacturer. This attribute was added in vSphere API +8.0.0.1. +if None, manufacturer is not available.

    • +

  • model (str or None) – The TPM model. This attribute was added in vSphere API 8.0.0.1. +if None, model is not available.

    • +

  • firmware_version (str or None) – The TPM firmware version. This attribute was added in vSphere API +8.0.0.1. +if None, firmware version is not available.

    • +

  • banks (list of com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank) – The list of the PCR banks of the TPM device. This attribute was +added in vSphere API 8.0.0.1.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm'
+

Resource type for TPM. This class attribute was added in vSphere API 8.0.0.1.

+
+ +
+
+class Summary(tpm=None, major_version=None, minor_version=None, active=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tpm.Summary class contains information that summarizes a TPM. This +class was added in vSphere API 8.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • tpm (str) – A unique identifier for the TPM instance. This attribute was added +in vSphere API 8.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

    • +

  • major_version (long) – The TPM major version number. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • minor_version (long) – The TPM minor version number. This attribute was added in vSphere +API 8.0.0.1.

    • +

  • active (bool) –

    The TPM status.

    +

    Inactive TPMs cannot be used for sealing or attestation.. This +attribute was added in vSphere API 8.0.0.1.

    +

    • +
+
+
+
+ +
+
+get(host, tpm)
+

Get the TPM details on a host. This method was added in vSphere API +8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • tpm (str) – the TPM identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

    • +
+
+
Return type
+

Tpm.Info

+
+
Returns
+

The TPM info.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any argument is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the TPM is not found or host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if too many requests are in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Tpm.Read.

    • +
+
+
+
+ +
+
+list(host, filter=None)
+

Return a list of configured TPMs on a host. This method was added in +vSphere API 8.0.0.1.

+
+
Parameters
+
    +

  • host (str) – Identifier of the host. +The parameter must be an identifier for the resource type: +HostSystem.

    • +

  • filter (Tpm.FilterSpec or None) – a filter for the returned list. +if \@term.unset}, the behavior is equivalent to a +Tpm.FilterSpec with attributes None

    • +
+
+
Return type
+

list of Tpm.Summary

+
+
Returns
+

A list of configured TPMs.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any argument is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the host is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if too many requests are in progress.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the caller is not authorized.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource HostSystem referenced by the parameter host +requires Host.Tpm.Read.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.html new file mode 100644 index 00000000..e02e9364 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.html @@ -0,0 +1,2121 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.trusted_infrastructure package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.attestation_client module

+

The com.vmware.vcenter.trusted_infrastructure.attestation_client module +provides classes for configuring Attestation Services for Trusted vCenter.

+
+
+class com.vmware.vcenter.trusted_infrastructure.attestation_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Services class contains information about the registered instances +of the Attestation Service in vCenter. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(address=None, trusted_ca=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.CreateSpec class contains the data necessary for +registering an Attestation Service instance to the environment. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • group (str) – The group specifies the Key Provider Service instances that can +accept reports issued by this Attestation Service instance. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Attestation +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class FilterSpec(services=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.FilterSpec class contains the data necessary for +identifying an Attestation Service instance. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • services (set of str or None) – A set of IDs by which to filter the services. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +If None, the services will not be filtered by ID.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – A set of address by which to filter. This attribute was added in +vSphere API 7.0.0.0. +If None, the services will not be filtered by address.

    • +

  • group (set of str or None) – The group specifies the Key Provider Service instances that can +accept reports issued by this Attestation Service instance. This +attribute was added in vSphere API 7.0.0.0. +If None, the services will not be filtered by group.

    • +

  • trust_authority_cluster (set of str or None) – The cluster specifies the Trust Authority Cluster this Attestation +Service belongs to. This attribute was added in vSphere API +7.0.0.0. +If None, the services will not be filtered by +trustAuthorityCluster.

    • +
+
+
+
+ +
+
+class Info(address=None, trusted_ca=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Info class contains all the stored information about a +registered Attestation Service instance. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • group (str) – The group specifies the Key Provider Service instances that can +accept reports issued by this Attestation Service instance. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Attestation +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.attestation.Service'
+

The resource type for the Attestation Service instances. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+class Summary(service=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Summary class contains basic information about a +registered Attestation Service instance. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • service (str) – The service’s unique identifier. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • group (str) – The group specifies the Key Provider Service instances that can +accept reports issued by this Attestation Service instance. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Attestation +Service instance belongs to. This attribute was added in vSphere +API 7.0.0.0.

    • +
+
+
+
+ +
+
+create(spec)
+

Registers a new Attestation Service instance in this vCenter. This +method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (Services.CreateSpec) – The CreateSpec for the new service.

+
+
Return type
+

str

+
+
Returns
+

ID of the newly registered Attestation Service instance. +The return value will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if there is already a Attestation Service instance with the same +Address.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the CreateSpec contains invalid data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ManageTrustedHosts.

    • +
+
+
+
+ +
+
+delete(service)
+

Removes a registered Attestation Service instance from this vCenter. +This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

service (str) – the Attestation Service instance unique identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if an error occurred while deleting the service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Attestation Service instance is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the Attestation Service instance is used by a configuration on a +cluster level.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ManageTrustedHosts.

    • +
+
+
+
+ +
+
+get(service)
+

Returns the detailed information about a registered Attestation Service +instance in this vCenter. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

service (str) – the Attestation Service instance unique identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

+
+
Return type
+

Services.Info

+
+
Returns
+

Detailed information about the specified Attestation Service +instance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if an error occurred while getting the data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no registered Attestation Service instance with the +specified ID.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +
+
+
+
+ +
+
+list(spec=None)
+

Returns detailed information about all registered Attestation Service +instances in this vCenter. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+

spec (Services.FilterSpec or None) – Return only services matching the specified filters. +If {\@term.unset} return all services.

+
+
Return type
+

list of Services.Summary

+
+
Returns
+

Detailed information about all registered Attestation Service +instances in this vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if an error occurred while getting the data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.attestation_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.hosts_client module

+

The com.vmware.vcenter.trusted_infrastructure.hosts_client module provides +classes to manage trusted infrastructure hosts.

+
+
+class com.vmware.vcenter.trusted_infrastructure.hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.kms_client module

+

The com.vmware.vcenter.trusted_infrastructure.kms_client module provides +classes for configuring Key Provider Services for Trusted vCenter.

+
+
+class com.vmware.vcenter.trusted_infrastructure.kms_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Services class contains information about the registered instances +of the Key Provider Service in vCenter. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(address=None, trusted_ca=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.CreateSpec class contains the data necessary for +registering a Key Provider Service instance to the environment. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • group (str) – The group determines the Attestation Service instances this Key +Provider service can accept reports from. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Key Provider +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class FilterSpec(services=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.FilterSpec class contains the data necessary for +identifying a Key Provider Service instance. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • services (set of str or None) – A set of IDs by which to filter the services. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. +If None, the services will not be filtered by ID.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – A set of address by which to filter. This attribute was added in +vSphere API 7.0.0.0. +If None, the services will not be filtered by address.

    • +

  • group (set of str or None) – The group determines the Attestation Service instances this Key +Provider Service can accept reports from. This attribute was added +in vSphere API 7.0.0.0. +If None, the Services will not be filtered by group.

    • +

  • trust_authority_cluster (set of str or None) – The cluster specifies the Trust Authority Cluster this Key Provider +Service belongs to. This attribute was added in vSphere API +7.0.0.0. +If None, the Services will not be filtered by +trustAuthorityCluster.

    • +
+
+
+
+ +
+
+class Info(address=None, trusted_ca=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Info class contains all the stored information about a +registered Key Provider Service instance. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • group (str) – The group determines the Attestation Service instances this Key +Provider Service can accept reports from. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Key Provider +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.kms.Service'
+

The resource type for the Key Provider Service instance. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+class Summary(service=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Summary class contains basic information about a +registered Key Provider Service instance. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • service (str) – The service’s unique identifier. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • group (str) – The group determines the Attestation Service instances this Key +Provider Service can accept reports from. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Key Provider +service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+create(spec)
+

Registers a Key Provider Service instance in this vCenter. This method +was added in vSphere API 7.0.0.0.

+
+
Parameters
+

spec (Services.CreateSpec) – The CreateSpec for the new service.

+
+
Return type
+

str

+
+
Returns
+

ID of the newly registered Key Provider Service instance. +The return value will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if there is already a Key Provider Service instance with the same +Address.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the CreateSpec contains invalid data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ManageTrustedHosts.

    • +
+
+
+
+ +
+
+delete(service)
+

Removes a currently registered Key Provider Service instance from this +vCenter. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

service (str) – the Key Provider Service instance unique identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if an error occurred while deleting the service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Key Provider Service instance is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the Key Provider Service instance is used by a configuration on +a cluster level.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ManageTrustedHosts.

    • +
+
+
+
+ +
+
+get(service)
+

Returns the detailed information about a registered Key Provider +Service instance in this vCenter. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+

service (str) – the Key Provider Service instance unique identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

+
+
Return type
+

Services.Info

+
+
Returns
+

Detailed information about the specified Key Provider Service +instance.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if an error occurred while getting the data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no Key Provider Service instance with the specified ID.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +
+
+
+
+ +
+
+list(spec=None)
+

Returns basic information about all registered Key Provider Service +instances in this vCenter. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+

spec (Services.FilterSpec or None) – Return only services matching the specified filters. +If {\@term.unset} return all services.

+
+
Return type
+

list of Services.Summary

+
+
Returns
+

Basic information about all registered Key Provider Service +instances in this vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if an error occurred while getting the data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.kms_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client +module provides the Trust Authority Components.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ConsumerPrincipals class configures the token policies and STS +trust necessary for the workload vCenter to query the trusted services for +their status. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(certificates=None, issuer_alias=None, issuer=None, principal=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConsumerPrincipals.CreateSpec class contains the information +necessary to establish trust between a workload vCenter and a Trust +Authority Host. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • certificates (list of com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The certificates used by the vCenter STS to sign tokens. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • issuer_alias (str) – A user-friendly alias of the service which created and signed the +security token. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer.

    • +

  • issuer (str) – The service which created and signed the security token. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • principal (com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal) – The principal used by the vCenter to retrieve tokens. This +attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class FilterSpec(id=None, principals=None, issuer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConsumerPrincipals.FilterSpec class contains data which identifies +a connection profile on the trusted vCenter. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (set of str or None) – The unqiue identifier of a connection profile. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.authentication.clientprofile. When methods +return a value of this class as a return value, the attribute will +contain identifiers for the resource type: +com.vmware.esx.authentication.clientprofile. +If None, no filtration will be performed by ID.

    • +

  • principals (list of com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal or None) – The principal used by the vCenter to retrieve tokens. This +attribute was added in vSphere API 7.0.0.0. +If None, no filtration will be performed by principals.

    • +

  • issuer (set of str or None) – The service which created and signed the security token. This +attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer. +If None, no filtration will be performed by issuer.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ConsumerPrincipals.Health class defines the possible health states. +This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Error. Not healthy. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

None. No status available. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

OK. Health is normal. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Warning. Health is normal, however there is an issue that requires +attention. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(id=None, principal=None, issuer_alias=None, issuer=None, certificates=None, health=None, message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConsumerPrincipals.Info class contains the information necessary to +establish trust between a workload vCenter and a Trust Authority Host. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The unqiue identifier of a connection profile. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.authentication.clientprofile. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.authentication.clientprofile.

    • +

  • principal (com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal) – The principal used by the vCenter to retrieve tokens. Currently +this is the vCenter solution user. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • issuer_alias (str) – A user-friendly alias of the service which created and signed the +security token. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer.

    • +

  • issuer (str) – The service which created and signed the security token. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • certificates (list of com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The certificates used by the vCenter STS to sign tokens. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • health (ConsumerPrincipals.Health) – The consistency of the profile across the hosts in the cluster. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • message (com.vmware.vapi.std_client.LocalizableMessage or None) – A localizable message describing the health of the profile. This +attribute was added in vSphere API 7.0.0.0. +If None, the certificates won’t be updated.

    • +
+
+
+
+ +
+
+class Summary(id=None, principal=None, issuer_alias=None, issuer=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConsumerPrincipals.Summary class contains a summary of the +information necessary to establish trust between a workload vCenter and a +Trust Authority Host. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • id (str) – The unqiue identifier of a connection profile. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.authentication.clientprofile. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.esx.authentication.clientprofile.

    • +

  • principal (com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal) – The principal used by the vCenter to retrieve tokens. Currently +this is the vCenter solution user. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • issuer_alias (str) – A user-friendly alias of the service which created and signed the +security token. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.esx.authentication.trust.security-token-issuer.

    • +

  • issuer (str) – The service which created and signed the security token. This +attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+create_task(cluster, spec)
+

Creates a profile with the specified connection information on all +hosts from a Trust Authority Cluster. This method was added in vSphere +API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the Trust Authority Cluster to configure. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (ConsumerPrincipals.CreateSpec) – The CreateSpec specifying the connection information.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a profile for the issuer already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no such cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+delete_task(cluster, profile)
+

Removes the read-only policy configured on ESX for a specific +principal. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the Trust Authority Cluster to configure. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • profile (str) – The ID of the connection profile to modify. +The parameter must be an identifier for the resource type: +com.vmware.esx.authentication.clientprofile.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no profile configured with that ID.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+get_task(cluster, profile)
+

Retrieve information for a specific profile. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the Trust Authority Cluster on which the profile is +configured. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • profile (str) – The ID of the profile. +The parameter must be an identifier for the resource type: +com.vmware.esx.authentication.clientprofile.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no profile configured with that ID.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+list_task(cluster, spec=None)
+

Lists all policies configured on a specific cluster. This method was +added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the Trust Authority Cluster on which the profile is +configured. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (ConsumerPrincipals.FilterSpec or None) – A FilterSpec specifying the profiles to be listed. +If {\@term.unset} return all policies.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no profile configured with that ID.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module

+

The com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client +module provides classes that provide information necessary to connect to the +hosts running the Trust Authority Components.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Attestation class contains information necessary to connect to the +hosts running Attestation Service. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(hosts=None, clusters=None, address=None, groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Attestation.FilterSpec class contains the data necessary for +identifying a Attestation Service. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hosts (set of str or None) – A set of host IDs by which to filter the services. This attribute +was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +If None, the services will not be filtered by the hosts on which +they run.

    • +

  • clusters (set of str or None) – A set of cluster IDs by which to filter the services. This +attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None, the services will not be filtered by the clusters on which +they run.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – The service’s address. This attribute was added in vSphere API +7.0.0.0. +If None, the services will not be filtered by address.

    • +

  • groups (set of str or None) – The group IDs determines which Attestation Service instances this +Attestation Service can communicate with. This attribute was added +in vSphere API 7.0.0.0. +If None, the services will not be filtered by groupId.

    • +
+
+
+
+ +
+
+class Info(host=None, address=None, group=None, cluster=None, trusted_ca=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Attestation.Info class contains all the stored information about a +Attestation Service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – The trusted ESX on which the service runs. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • group (str) – The group ID determines which Attestation Service instances this +Attestation Service can communicate with. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • cluster (str) – The opaque string identifier of the cluster in which the +Attestation Service is part of. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(summary_type=None, host=None, address=None, group=None, cluster=None, trusted_ca=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Attestation.Summary class contains all the stored information about +a Attestation Service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class SummaryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The connection information could include the certificates or be a shorter +summary. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SummaryType instance.

+
+
+
+
+BRIEF = SummaryType(string='BRIEF')
+

A brief summary, containing only the hostname for the Attestation Service. +This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+FULL = SummaryType(string='FULL')
+

The full connection information, including certificates. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+NORMAL = SummaryType(string='NORMAL')
+

A summary containing only the hostname, port, and the group ID which +determines the Attestation Services this Attestation Service can +communicate with. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+get(host)
+

Returns the connection info about the Attestation Service running on +the specified host. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

host (str) – \@{link com.vmware.vcenter.Host} id. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Attestation.Info

+
+
Returns
+

The Attestation.Info instance which contains the +information necessary to connect to the Attestation Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if service’s TLS certificate chain is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if host doesn’t match to any Host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if connection to host failed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource HostSystem referenced by the parameter host +requires System.View.

    • +
+
+
+
+ +
+
+list(spec=None, projection=None)
+

Returns a list of the hosts running a Attestation Service matching the +specified Attestation.FilterSpec. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • spec (Attestation.FilterSpec or None) – Return details about Attestation Services matching the filter. +If {\@term.unset} return all registered Attestation Services.

    • +

  • projection (Attestation.SummaryType or None) – The type of the returned summary - brief, normal, or full. +If {\@term.unset} a normal projection will be used.

    • +
+
+
Return type
+

list of Attestation.Summary

+
+
Returns
+

List of Attestation.Summary of Attestation Services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the response data will exceed the message limit.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource HostSystem referenced by the attribute +Attestation.FilterSpec.hosts requires System.View.

    • +

  • The resource ClusterComputeResource referenced by the +attribute Attestation.FilterSpec.clusters requires +System.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Kms class contains information necessary to connect to the hosts +running Key Provider Service. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(hosts=None, clusters=None, address=None, groups=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Kms.FilterSpec class contains the data necessary for identifying a +Key Provider Service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hosts (set of str or None) – A set of host IDs by which to filter the services. This attribute +was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will contain identifiers for the +resource type: HostSystem. +If None, the services will not be filtered by the hosts on which +they run.

    • +

  • clusters (set of str or None) – A set of cluster IDs by which to filter the services. This +attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will contain identifiers for +the resource type: ClusterComputeResource. +If None, the services will not be filtered by the clusters on which +they run.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – The service’s address. This attribute was added in vSphere API +7.0.0.0. +If None, the services will not be filtered by address.

    • +

  • groups (set of str or None) – The group determines reports issued by which Attestation Service +instances this Key Provider Service can accept. This attribute was +added in vSphere API 7.0.0.0. +If None, the services will not be filtered by groupId.

    • +
+
+
+
+ +
+
+class Info(host=None, address=None, group=None, cluster=None, trusted_ca=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Kms.Info class contains all the stored information about a Key +Provider Service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host (str) – The trusted ESX on which the service runs. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • group (str) – The group ID determines which Attestation Service instances this +Key Provider Service can communicate with. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • cluster (str) – The opaque string identifier of the cluster in which the Key +Provider Service is part of. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(summary_type=None, host=None, address=None, group=None, cluster=None, trusted_ca=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Kms.Summary class contains all the stored information about a Key +Provider Service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • summary_type (Kms.SummaryType) – Defines the verbosity of the summary. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • host (str) – The trusted ESX on which the service runs. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute is optional and it is only relevant when the value +of summaryType is one of Kms.SummaryType.BRIEF, +Kms.SummaryType.NORMAL, or Kms.SummaryType.FULL.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0. +This attribute is optional and it is only relevant when the value +of summaryType is one of Kms.SummaryType.BRIEF, +Kms.SummaryType.NORMAL, or Kms.SummaryType.FULL.

    • +

  • group (str) – The group ID determines which Attestation Service instances this +Key Provider Service can communicate with. This attribute was added +in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of summaryType is one of Kms.SummaryType.NORMAL or +Kms.SummaryType.FULL.

    • +

  • cluster (str) – The opaque string identifier of the cluster in which the Key +Provider Service is part of. This attribute was added in vSphere +API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of summaryType is one of Kms.SummaryType.NORMAL or +Kms.SummaryType.FULL.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of summaryType is Kms.SummaryType.FULL.

    • +
+
+
+
+ +
+
+class SummaryType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The connection information could include the certificates or be a shorter +summary. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SummaryType instance.

+
+
+
+
+BRIEF = SummaryType(string='BRIEF')
+

A brief summary, containing only the hostname for the Key Provider Service. +This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+FULL = SummaryType(string='FULL')
+

The full connection information, including certificates. This class +attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+NORMAL = SummaryType(string='NORMAL')
+

A summary containing only the hostname, port, and the group which +determines the Attestation Services this Key Provider Service can +communicate with. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+get(host)
+

Returns the connection info about the Key Provider Service running on +the specified host. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

host (str) – \@{link com.vmware.vcenter.Host} id. +The parameter must be an identifier for the resource type: +HostSystem.

+
+
Return type
+

Kms.Info

+
+
Returns
+

The Kms.Info instance which contains the information +necessary to connect to the Key Provider Service.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if service’s TLS certificate chain is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if host doesn’t match to any Host.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if connection to host failed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource HostSystem referenced by the parameter host +requires System.View.

    • +
+
+
+
+ +
+
+list(spec=None, projection=None)
+

Returns a list of the hosts running a Key Provider Service matching the +specified Kms.FilterSpec. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • spec (Kms.FilterSpec or None) – Return details about Key Provider Services matching the filter. +If {\@term.unset} return all registered Key Provider Services.

    • +

  • projection (Kms.SummaryType or None) – The type of the returned summary - brief, normal, or full. +If {\@term.unset} a normal projection will be used.

    • +
+
+
Return type
+

list of Kms.Summary

+
+
Returns
+

List of Kms.Summary of Key Provider Services.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the response data will exceed the message limit.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource HostSystem referenced by the attribute +Kms.FilterSpec.hosts requires System.View.

    • +

  • The resource ClusterComputeResource referenced by the +attribute Kms.FilterSpec.clusters requires System.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module

+

The com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client +module provides classes for configuring Trusted Clusters.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ServicesAppliedConfig class provides information about the +aggregate health of the applied Trust Authority Component configurations on +the Trusted Clusters. The desired state of the Trust Authority Component +configurations is stored within vCenter, while the applied configuration is +stored on the hosts in the cluster and is a copy of the desired state. The +ServicesAppliedConfig class is available for all clusters, not only +Trusted Clusters. When an applied Trust Authority Component configuration +is found outside of a Trusted Cluster it is considered an +ServicesAppliedConfig.Health.ERROR. The ServicesAppliedConfig +class is able to make the applied Trust Authority Component configuration +consistent with the desired state when individual host configurations have +diverged from the desired state. This class was added in vSphere API +7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ServicesAppliedConfig.Health class is an indicator for the +consistency of all applied Trust Authority Component configurations in a +cluster with respect to the desired state. This enumeration was added in +vSphere API 7.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Some applied Trust Authority Component configurations have diverged from +the desired state. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+NONE = Health(string='NONE')
+

The consistency of some applied configurations is unknown. This class +attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+OK = Health(string='OK')
+

All the applied Trust Authority Component configurations are consistent +with the desired state. This class attribute was added in vSphere API +7.0.1.0.

+
+ +
+ +
+
+class Info(health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.Info class contains detailed information +about the health of the applied Trust Authority Component configurations in +a cluster. This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+delete_task(cluster)
+

Delete all Trust Authority Components configuration that has been +applied to the given cluster. This method has no affect on the desired +state, it only removes applied Trust Authority Component configurations +from any Trusted Hosts within the given cluster. This method was added +in vSphere API 7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get_task(cluster)
+

Returns detailed information about the health of the applied Trust +Authority Component configurations in the given cluster. This method +was added in vSphere API 7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+update_task(cluster)
+

Update all applied Trust Authority Component configuration on the given +cluster to be consistent with the desired state. This method has no +affect on the desired state, apart from it being used as a reference +point for the remediation. If the cluster is not a Trusted Cluster, the +method will remove all Trust Authority Component configuration from the +Trusted Hosts in the cluster, if such hosts are found. This method was +added in vSphere API 7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html new file mode 100644 index 00000000..88b117c8 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html @@ -0,0 +1,1057 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client +module provides classes to manage remote attestation configuration for TPM +trust.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.CaCertificates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The CaCertificates class provides methods to manage Trusted Platform +Module (TPM) CA certificates.

+

Endorsement Keys are typically packaged in a certificate that is signed by +a certificate authority (CA). This class allows the CA certificate to be +registered with the Attestation Service in order to validate TPM EK +certificates when presented at attestation time.. This class was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, cert_chain=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CaCertificates.CreateSpec class contains information that describes +a TPM CA certificate. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – A unique name for the TPM CA certificate. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

    • +

  • cert_chain (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain or None) –

    The CA certificate chain.

    +

    Certificates may either be added one at a time, or as a chain. +Adding the certificates as a chain allows the group to be managed +as a whole. For example, an entire chain can be deleted in one +CaCertificates.delete() operation.

    +

    When certificates are added one at a time, the order must be root +first, followed by any intermediates. The intermediates +certificates must also be ordered in the direction from root to +leaf.

    +

    Similarly, when added as a chain the list must be ordered in the +direction from root to leaf.. This attribute was added in vSphere +API 7.0.0.0. +If None creation will fail.

    +

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The CaCertificates.Health class is indicator for the consistency of the +hosts status in the cluster. This enumeration was added in vSphere API +7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Not all hosts in the cluster are in consistent state. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Each host in the cluster is in consistent state with the rest hosts in the +cluster. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Attestation is funtioning, however there is an issue that requires +attention. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(cert_chain=None, health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CaCertificates.Info class contains information that describes a TPM +CA certificate. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate'
+

Resource type for TPM 2.0 CA certificates. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+class Summary(name=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CaCertificates.Summary class contains information that summarizes a +TPM CA certificate. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – A unique name for the TPM CA certificate. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

    • +

  • health (CaCertificates.Health) – A health indicator which indicates whether each host in the cluster +has the same CA certs. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+create_task(cluster, spec)
+

Add a new TPM CA certificate on a cluster. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (CaCertificates.CreateSpec) – The new CA certificate details.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the certificate name exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the configuration is invalid or the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t match to any cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+delete_task(cluster, name)
+

Remove a TPM CA certificate on a cluster. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • name (str) – The CA certificate name. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the name is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster doesn’t match to any cluster in the vCenter or +given name is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get_task(cluster, name)
+

Get the TPM CA certificate details on a cluster. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • name (str) – The CA certificate name. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the name is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the CA certificate is not found or cluster doesn’t match to +any cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+list_task(cluster)
+

Return a list of configured TPM CA certificates on a cluster. This +method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster doesn’t match to any cluster in the vCenter or +given name is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.EndorsementKeys(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The EndorsementKeys class provides methods to manage Trusted Platform +Module (TPM) Endorsement Keys (EK) on a cluster level. This class was added +in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(name=None, public_key=None, certificate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.CreateSpec class contains information that +describes a TPM endorsement key.

+

Only one of EndorsementKeys.CreateSpec.public_key or +EndorsementKeys.CreateSpec.certificate must be specified.. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) –

    A unique name for the TPM endorsement key.

    +

    The unique name should be something that an administrator can use +to easily identify the remote system. For example, the hostname, or +hardware UUID.. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

    +

    • +

  • public_key (str or None) – TPM public endorsement key in PEM format. This attribute was added +in vSphere API 7.0.0.0. +If None EndorsementKeys.CreateSpec.certificate must be +set.

    • +

  • certificate (str or None) –

    TPM endorsement key certificate in PEM format.

    +

    When a endorsement key certificate is provided, it will be verified +against the CA certificate list. Endorsement key certificates that +are not signed by one of the CA certificates will be rejected.

    +

    Using this format allows for failures to be caught during +configuration rather than later during attestation.. This attribute +was added in vSphere API 7.0.0.0. +If None EndorsementKeys.CreateSpec.public_key must be +set.

    +

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The EndorsementKeys.Health class is indicator for the consistency of +the hosts status in the cluster. This enumeration was added in vSphere API +7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Not all hosts in the cluster are in consistent state. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Each host in the cluster is in consistent state with the rest hosts in the +cluster. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Attestation is functioning, however there is an issue that requires +attention. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(public_key=None, health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.Info class contains information that describes a +TPM endorsement key. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • public_key (str) – TPM public endorsement key in PEM format. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • health (EndorsementKeys.Health) – A health indicator which indicates whether each host in the cluster +has the same endorsement key. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health.

    +

    When the EndorsementKeys.Health is not +EndorsementKeys.Health.OK or +EndorsementKeys.Health.NONE, this member will provide an +actionable description of the issues present.. This attribute was +added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey'
+

Resource type for TPM 2.0 endorsement keys. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+class Summary(name=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The EndorsementKeys.Summary class contains information that summarizes +a TPM endorsement key. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – A unique name for the TPM endorsement key. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

    • +

  • health (EndorsementKeys.Health) – A health indicator which indicates whether each host in the cluster +has the same endorsement key. This attribute was added in vSphere +API 7.0.0.0.

    • +
+
+
+
+ +
+
+create_task(cluster, spec)
+

Add a new TPM endorsement key on a cluster. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (EndorsementKeys.CreateSpec) – The configuration.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the endorsement key name exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the configuration is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t match to any cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+delete_task(cluster, name)
+

Remove a TPM endorsement key on a cluster. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • name (str) – The endorsement key name. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the name is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the name is not found or cluster doesn’t match to any +cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get_task(cluster, name)
+

Get the TPM endorsement key details on a cluster. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • name (str) – The endorsement key name. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the name is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the endorsement key is not found or cluster doesn’t match to +any cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+list_task(cluster)
+

Return a list of configured TPM endorsement keys in a cluster. This +method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.Settings(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Settings interface provides methods to get or update settings +related to the TPM 2.0 attestation protocol behavior. This class was added +in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Settings.Health class is indicator for the consistency of the hosts +status in the cluster. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Not all hosts in the cluster are in consistent state. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Each host in the cluster is in consistent state with the rest hosts in the +cluster. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Attestation is functioning, however there is an issue that requires +attention. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(require_endorsement_keys=None, require_certificate_validation=None, health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Settings.Info class contains information that describes the TPM 2.0 +protocol settings. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • require_endorsement_keys (bool) –

    Require registered TPM endorsement keys.

    +

    During attestation, the attested host will always send its +endorsement key to the Attestation Service. With this option is +set, the Attestation Service will only proceed with attestation if +the endorsement key has been added to the list of configured +trusted endorsement keys.. This attribute was added in vSphere API +7.0.0.0.

    +

    • +

  • require_certificate_validation (bool) –

    Require TPM endorsement key certificate validation.

    +

    During attestation, the attested host will send its endorsement key +certificate if one is available. With this option set, the +Attestation Service will validate the endorsement key certificate +against the list of configured trusted TPM CA certificates. Only +endorsement key certificates that are signed by a trusted TPM CA +certificate will be able to successfully attest.. This attribute +was added in vSphere API 7.0.0.0.

    +

    • +

  • health (Settings.Health) – A health indicator which indicates whether each host in the cluster +has the same attestation settings. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health.

    +

    When the Settings.Health is not Settings.Health.OK or +Settings.Health.NONE, this member will provide an +actionable description of the issues present.. This attribute was +added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+class UpdateSpec(require_endorsement_keys=None, require_certificate_validation=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Settings.UpdateSpec class contains information that describes +changes to the TPM 2.0 protocol settings. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • require_endorsement_keys (bool or None) – Require registered TPM endorsement keys. This attribute was added +in vSphere API 7.0.0.0. +If None the current state will remain unchanged.

    • +

  • require_certificate_validation (bool or None) – Require TPM endorsement key certificate validation. This attribute +was added in vSphere API 7.0.0.0. +If None the current state will remain unchanged.

    • +
+
+
+
+ +
+
+get_task(cluster)
+

Return the TPM 2.0 protocol settings. This method was added in vSphere +API 7.0.0.0.

+
+
Parameters
+

cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t match to any cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+update_task(cluster, spec)
+

Set the TPM 2.0 protocol settings. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Settings.UpdateSpec) – The settings.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the spec is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if cluster doesn’t match to any cluster in the vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html new file mode 100644 index 00000000..4dddbf33 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html @@ -0,0 +1,506 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package

+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client +module provides the interfaces for configuring ESX host metadata.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The BaseImages class provides methods to manage trusted instances of +ESX software on a cluster level. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(version=None, display_name=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImages.FilterSpec class contains the data necessary for +identifying a Trust Authority Host in a cluster. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (set of str or None) – Search criteria by ESX base image version numbers. This attribute +was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage. +When methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage. +version if {\@term.unset} return all ESX version numbers.

    • +

  • display_name (set of str or None) – Search criteria by ESX base image version version numbers. This +attribute was added in vSphere API 7.0.0.0. +displayName if {\@term.unset} return all ESX display version +numbers.

    • +

  • health (set of BaseImages.Health or None) – Search criteria by health indicator. This attribute was added in +vSphere API 7.0.0.0. +health if {\@term.unset} return all health indicators.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The BaseImages.Health class is indicator for the consistency of the +hosts status in the cluster. This enumeration was added in vSphere API +7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Not all hosts in the cluster are in consistent state. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Each host in the cluster is in consistent state with the rest hosts in the +cluster. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Attestation is funtioning, however there is an issue that requires +attention. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(display_name=None, last_attested_time=None, health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImages.Info class contains information that describes an ESX +base image. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • display_name (str) – A unique ESX version formatted for display. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • last_attested_time (datetime.datetime or None) – The last time that an attestation completed successfully using this +ESX base image. This attribute was added in vSphere API 8.0.1.0. +If None, then there is no known last attestation time using this +ESX base image.

    • +

  • health (BaseImages.Health) – A health indicator which indicates whether each host in the cluster +has this version of the ESX base image. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health.

    +

    When the BaseImages.Health is not BaseImages.Health.OK +or BaseImages.Health.NONE, this member will provide an +actionable description of the issues present.. This attribute was +added in vSphere API 7.0.0.0.

    +

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage'
+

Resource type for ESX base image. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+class Summary(version=None, display_name=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The BaseImages.Summary class contains information that summarizes an +ESX base image. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – A unique ESX version number. This attribute was added in vSphere +API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage.

    • +

  • display_name (str) – A unique ESX version formatted for display. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • health (BaseImages.Health) – A health indicator which indicates whether each host in the cluster +has this version of the ESX base image. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+delete_task(cluster, version)
+

Remove a trusted ESX base image of each ESX in the cluster. This method +was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • version (str) – The ESX base image version. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the version is invalid or the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the version or cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get_task(cluster, version)
+

Get the trusted ESX base version details. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • version (str) – The ESX base image version. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the version is invalid or the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the version or cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+import_from_imgdb_task(cluster, imgdb)
+

Import ESX metadata as a new trusted base image to each host in the +cluster.

+

Import a boot_imgdb.tgz file which contains metadata that describes a +trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a +representative host.. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • imgdb (str) – ESX metadata on a cluster level.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if ESX metadata for the same version has already been added.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the imgdb is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+list_task(cluster, spec=None)
+

Return a list of trusted ESX base images. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The id of the cluster on which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (BaseImages.FilterSpec or None) – The search specification. +if {\@term.unset} return all information.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html new file mode 100644 index 00000000..1aa975ee --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html @@ -0,0 +1,1231 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client +module provides classes for configuring the Attestation Service. It attests the +state of a remote infrastructure node.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ServiceStatus class provides methods to get the Attestation Service +health status. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ServiceStatus.Health class defines the possible service health +states. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Service is not functioning. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Service is functioning normally. This class attribute was added in vSphere +API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Service is functioning, however there is an issue that requires attention. +This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServiceStatus.Info class contains information that describes the +status of the service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+get_task(cluster)
+

Return the Attestation service health in the given cluster. This method +was added in vSphere API 7.0.0.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client +module provides the interfaces for configuring the Key Provider Service. It +encapsulates one or more key servers and exposes Trusted Key Providers.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Providers interface provides methods to create, update and delete +Key Providers that handoff to key servers. This class was added in vSphere +API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(provider=None, master_key_id=None, key_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.CreateSpec class contains attributes that describe the +desired configuration for a new Key Provider. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) –

    Name of the provider.

    +

    A unique string chosen by the client.. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    +

    • +

  • master_key_id (str) –

    Master key ID created for the provider.

    +

    A unique Key ID.. This attribute was added in vSphere API 7.0.0.0.

    +

    • +

  • key_server (Providers.KeyServerCreateSpec) – Key server associated with this Provider. This attribute was added +in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.Health class defines the possible health states. This +enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Not healthy. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Health is normal. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Health is normal, however there is an issue that requires attention. This +class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(master_key_id=None, key_server=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Info class contains attributes that describe the current +configuration of a provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • master_key_id (str) –

    Master key identifier created for the provider.

    +

    A unique Key identifier.. This attribute was added in vSphere API +7.0.0.0.

    +

    • +

  • key_server (Providers.KeyServerInfo) – Key server associated with this provider. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • status (Providers.Status) – Status of the provider in the cluster. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class KeyServerCreateSpec(type=None, description=None, proxy_server=None, connection_timeout=None, kmip_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.KeyServerCreateSpec class contains attributes that +describe the desired configuration for the key server. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Providers.KeyServerCreateSpec.Type) – Type of the key server. This attribute was added in vSphere API +7.0.0.0.

    • +

  • description (str or None) – Description of the key server. This attribute was added in vSphere +API 7.0.0.0. +If None, description will not be added.

    • +

  • proxy_server (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – Proxy server configuration. This attribute was added in vSphere API +7.0.0.0. +If None, the key server will not use a proxy server.

    • +

  • connection_timeout (long or None) – Connection timeout in seconds. This attribute was added in vSphere +API 7.0.0.0. +If None, connection timeout will not be set.

    • +

  • kmip_server (Providers.KmipServerCreateSpec) – Configuration information for Key Management Interoperability +Protocol (KMIP) based key server. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Providers.KeyServerCreateSpec.Type.KMIP.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.KeyServerCreateSpec.Type class lists the key server +types. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+KMIP = Type(string='KMIP')
+

Key Management Interoperability Protocol (KMIP) based key management +server. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class KeyServerInfo(type=None, description=None, proxy_server=None, connection_timeout=None, kmip_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.KeyServerInfo class contains attributes that describe the +current configuration of a key server. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Providers.KeyServerInfo.Type) – Type of the key server. This attribute was added in vSphere API +7.0.0.0.

    • +

  • description (str) – Description of the key server. This attribute was added in vSphere +API 7.0.0.0.

    • +

  • proxy_server (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) –

    Proxy server configuration.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, proxy server configuration will not be set.

    +

    • +

  • connection_timeout (long or None) –

    Connection timeout in seconds.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, connection timeout will be unset.

    +

    • +

  • kmip_server (Providers.KmipServerInfo) – Configuration information for KMIP based key server. This attribute +was added in vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Providers.KeyServerInfo.Type.KMIP.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.KeyServerInfo.Type class list the key server types. This +enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+KMIP = Type(string='KMIP')
+

Key Management Interoperability Protocol (KMIP) based key management +server. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class KeyServerUpdateSpec(type=None, description=None, proxy_server=None, connection_timeout=None, kmip_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.KeyServerUpdateSpec class contains attributes that +describe new configuration for an existing key server. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Providers.KeyServerUpdateSpec.Type or None) –

    Type of the key server.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, key server type and configuration information will remain +unchanged. In this case all key server configuration information +fields (e.g KMIP) should be unset.

    +

    • +

  • description (str or None) –

    Description of the key server.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, description will remain unchanged.

    +

    • +

  • proxy_server (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) –

    Proxy server configuration.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, proxy server configuration will remain unchanged.

    +

    • +

  • connection_timeout (long or None) –

    Connection timeout in seconds.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, connection timeout will remain unchanged.

    +

    • +

  • kmip_server (Providers.KmipServerUpdateSpec or None) –

    Configuration information for KMIP based key server.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, kmip server configuration will remain unchanged.

    +

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Providers.KeyServerUpdateSpec.Type class list the key server types. +This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+KMIP = Type(string='KMIP')
+

Key Management Interoperability Protocol (KMIP) based key management +server. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class KmipServerCreateSpec(servers=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.KmipServerCreateSpec class contains attributes that +describe Key Management Interoperability Protocol (KMIP) desired key server +configuration. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of Providers.Server) –

    List of Key Management Interoperability Protocol (KMIP) compliant +key servers.

    +

    Key servers must be configured for active-active replication. If +the server port is None, a default value for KMIP’s port will be +used.. This attribute was added in vSphere API 7.0.0.0.

    +

    • +

  • username (str or None) – Username for authentication. This attribute was added in vSphere +API 7.0.0.0. +If None, no username will be added.

    • +
+
+
+
+ +
+
+class KmipServerInfo(servers=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.KmipServerInfo class contains attributes that describe +the current configuration of a KMIP based key server. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of Providers.Server) – List of KMIP compliant key servers. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • username (str or None) –

    Username for authentication.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, username will not be set.

    +

    • +
+
+
+
+ +
+
+class KmipServerUpdateSpec(servers=None, username=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.KmipServerUpdateSpec class contains attributes that +describe new configuration for KMIP based key server. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • servers (list of Providers.Server or None) –

    List of KMIP compliant key servers.

    +

    Key servers must be configured for active-active replication. If +the server port is None, a default value for KMIP’s port will be +used.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, server configuration will remain unchanged.

    +

    • +

  • username (str or None) –

    Username for authentication.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, username will remain unchanged.

    +

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider'
+

Resource type for a Key Provider. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+class Server(name=None, address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Server class contains attributes that describe a +connection endpoint. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class ServerInfo(health=None, details=None, client_trust_server=None, server_trust_client=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.ServerInfo class contains attributes that describe the +status of a key server. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (Providers.Health) – The connection status health of the server. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health of the server connection.

    +

    When the service Providers.Health is not +Providers.Health.OK, this attribute will provide an +actionable description of the issue.. This attribute was added in +vSphere API 7.0.0.0.

    +

    • +

  • client_trust_server (bool) – Whether this client trusts the server. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • server_trust_client (bool) – Whether the server trusts this client. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • name (str) – Name of the server. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class Status(health=None, details=None, servers=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Status class contains attributes that describe the status +of the Key Provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (Providers.Health) – The health of the provider. This attribute was added in vSphere API +7.0.0.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Details regarding the health of the provider.

    +

    When the service Providers.Health is not +Providers.Health.OK, this attribute will provide an +actionable description of the issue.. This attribute was added in +vSphere API 7.0.0.0.

    +

    • +

  • servers (list of Providers.ServerInfo) – Health of the key servers. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(provider=None, health=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.Summary class contains attributes that summarize a +provider. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • provider (str) –

    Name of the provider.

    +

    A unique string chosen by the client.. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    +

    • +

  • health (Providers.Health) – Health of the provider in the cluster. This attribute was added in +vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class UpdateSpec(master_key_id=None, key_server=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Providers.UpdateSpec class contains attributes that describe the +new configuration for an existing provider. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • master_key_id (str or None) –

    Master key identifier created for the provider.

    +

    A unique Key identifier.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, masterKeyId will remain unchanged.

    +

    • +

  • key_server (Providers.KeyServerUpdateSpec or None) –

    Key server associated with this provider.

    +

    . This attribute was added in vSphere API 7.0.0.0. +If None, key server configuration will remain unchanged.

    +

    • +
+
+
+
+ +
+
+create_task(cluster, spec)
+

Add a new Key Provider. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Providers.CreateSpec) – Provider information.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +If the provider already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the spec is invalid or cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
+
+ +
+
+delete_task(cluster, provider)
+

Remove a Key Provider. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster or provider id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
+
+ +
+
+get_task(cluster, provider)
+

Return information about a Key Provider. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster or provider id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
+
+ +
+
+list_task(cluster)
+

Return a list of summary of Key Providers. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
+
+ +
+
+update_task(cluster, provider, spec)
+

Update an existing Key Provider. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +

  • spec (Providers.UpdateSpec) – Provider information.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster or provider id is empty, or the spec is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ServiceStatus class provides methods to get the Key Provider +Service health status. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ServiceStatus.Health class defines the possible service health +states. This enumeration was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

Service is not functioning. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+NONE = Health(string='NONE')
+

No status available. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+OK = Health(string='OK')
+

Service is functioning normally. This class attribute was added in vSphere +API 7.0.0.0.

+
+ +
+
+WARNING = Health(string='WARNING')
+

Service is functioning, however there is an issue that requires attention. +This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class Info(health=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServiceStatus.Info class contains information that describes the +status of the service. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+get_task(cluster)
+

Return the Key Provider Service health in the given cluster. This +method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html new file mode 100644 index 00000000..2744ca73 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html @@ -0,0 +1,681 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client +module provides the classes for configuring the Key Providers of a Trust +Authority Cluster.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.ClientCertificate(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ClientCertificate interface provides methods to add and retrieve +client certificate. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(certificate=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClientCertificate.Info class contains the client certificate used +by the hosts in a cluster for authenticating with the Provider. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

certificate (str) – Public certificate. This attribute was added in vSphere API +7.0.0.0.

+
+
+
+ +
+
+class UpdateSpec(certificate=None, private_key=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ClientCertificate.UpdateSpec class contains attributes that +describe the client certificate update for a Key Provider. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • certificate (str) – Public certificate used by every host in the cluster. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • private_key (str or None) – Private part of the certificate. This attribute was added in +vSphere API 7.0.0.0. +If None, the update request is for a public/private client +certificate pair, not for a signed CSR.

    • +
+
+
+
+ +
+
+create_task(cluster, provider)
+

Generate a new self signed client certificate. Existing client +certificate is overwritten. The key server will use this certificate to +validate the client connection. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If cluster or provider id are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+get_task(cluster, provider)
+

Return the existing client certificate. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If cluster or provider id are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+update_task(cluster, provider, spec)
+

Update the client certificate.

+

The key server will use this certificate to validate the client +connection. If a client certificate already exists, it will be +replaced.

+

An optional private key can be specified if the certificate has already +been provisioned.. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +

  • spec (ClientCertificate.UpdateSpec) – The update spec.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the certificate or private key is invalid or cluster/provider id +are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.Credential(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Credential interface provides methods to add a credential for +external key management service(s). This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+set_task(cluster, provider, credential)
+

Set the key server credential. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +

  • credential (str) – KMIP KMS password or AWS access key.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If cluster or provider id are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the provider or cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.CurrentPeerCertificates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Retrieves the list of TLS certificates used by peer key servers. Those are +meant for review. Following approval these certificates should be added as +trusted certificates in the TrustedPeerCertificates class. This +class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(server_names=None, trusted=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CurrentPeerCertificates.FilterSpec class contains attributes used +to filter the results when listing remote server certificates. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server_names (set of str or None) – Names that key server must have to match the filter (see +CurrentPeerCertificates.Summary.server_name). This +attribute was added in vSphere API 7.0.0.0. +If None or empty, key servers with any name match the filter.

    • +

  • trusted (bool or None) – Trust status that server certificates must have to match the filter +(see CurrentPeerCertificates.Summary.trusted). This +attribute was added in vSphere API 7.0.0.0. +If None, trusted and untrusted server certificates match the +filter.

    • +
+
+
+
+ +
+
+class Summary(server_name=None, certificate=None, error_messages=None, trusted=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CurrentPeerCertificates.Summary class contains a summary of the +current key server certificates. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • server_name (str) – Name of the server. This attribute was added in vSphere API +7.0.0.0.

    • +

  • certificate (str or None) – Server certificate. This attribute was added in vSphere API +7.0.0.0. +If None, the certificate cannot be retrieved from the remote +system, and CurrentPeerCertificates.Summary.trusted is +undefined. See +CurrentPeerCertificates.Summary.error_messages for details.

    • +

  • error_messages (list of com.vmware.vapi.std_client.LocalizableMessage) –

    Server certificate retrieval errors.

    +

    Specifies error details when retrieving the remote server +certificate fails. This list will be empty when +CurrentPeerCertificates.Summary.certificate is +set.. This attribute was added in vSphere API 7.0.0.0.

    +

    • +

  • trusted (bool) – whether server certificate is already trusted . This attribute was +added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+list_task(cluster, provider, spec=None)
+

Return the remote server certificates.

+

Contacts the configured key servers and attempts to retrieve their +certificates. These certificates might not yet be trusted.

+

If the returned certificates are to be considered trustworthy, then it +must be added to the list of trusted server certificates by adding to +the certificates returned by TrustedPeerCertificates.get() and +invoking TrustedPeerCertificates.update() with the updated +list of certificates.. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +

  • spec (CurrentPeerCertificates.FilterSpec or None) – Filter spec. +If None, the behavior is equivalent to a +CurrentPeerCertificates.FilterSpec with all attributes +None

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the cluster or provider id is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +For any other error.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.TrustedPeerCertificates(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Provides management operations for the TLS certificates trusted for +communication with peer key servers.

+

To obtain the currently used TLS certificates use the +CurrentPeerCertificates class. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(certificates=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedPeerCertificates.Info class contains x509 certificate list. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

certificates (list of str) – List of certificate strings, PEM format. This attribute was added +in vSphere API 7.0.0.0.

+
+
+
+ +
+
+class UpdateSpec(certificates=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The TrustedPeerCertificates.UpdateSpec class contains attributes that +describe the server certificate update for a Key Provider. This class was +added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

certificates (list of str or None) – Public certificates of key server to trust. This attribute was +added in vSphere API 7.0.0.0. +If None, the trusted server certificates will not be updated.

+
+
+
+ +
+
+get_task(cluster, provider)
+

Return the list of trusted server certificates. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If cluster or provider id are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+update_task(cluster, provider, spec)
+

Update trusted server certificate(s).

+

The client will use these certificates to validate the server +connection. The existing list of trusted certificates will be +overwritten.

+

The client will not trust the server connection until a server +certificate has been set.. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +

  • spec (TrustedPeerCertificates.UpdateSpec) – The update spec

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If one or more certificates are invalid or the cluster/provider Id +is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the cluster or provider is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html new file mode 100644 index 00000000..2845dfac --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html @@ -0,0 +1,287 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package

+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client +module provides the interfaces for configuring the Client Certificate used by +the Key Provider Service to authenticate against the Key Servers.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client.Csr(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Csr interface provides methods to create a certificate signing +request(CSR). This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(csr=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Csr.Info class contains the certificate signing request. This class +was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

csr (str) – Certificate signing request. This attribute was added in vSphere +API 7.0.0.0.

+
+
+
+ +
+
+create_task(cluster, provider)
+

Generate a certificate signing request (CSR) for the client +certificate. This overwrites any existing CSR.

+

The CSR will allow the certificate to be signed by a third party. Once +the CSR is signed, certificate may be added as a client certificate.

+

Calling the API repeatedly will result in a generating a new CSR each +time.. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If cluster or provider id are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the provider or cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+get_task(cluster, provider)
+

Get existing certificate signing request (CSR) for the client +certificate.

+

The CSR will allow the certificate to be signed by a third party. Once +the CSR is signed, certificate may be added as a client certificate.

+

. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – Identifier of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • provider (str) – Identifier of the provider. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If cluster or provider id are empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the provider or cluster is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +If the caller is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html new file mode 100644 index 00000000..2e1785a1 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html @@ -0,0 +1,1645 @@ + + + + + + + com.vmware.vcenter.trusted_infrastructure.trusted_clusters package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.trusted_infrastructure.trusted_clusters package

+
+

Submodules

+
+
+

com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module

+

The +com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client +module provides classes for configuring Attestation Services for Trusted +Clusters.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Services class manages the Attestation Service instances a Trusted +Cluster is configured to use. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(type=None, service=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.CreateSpec class contains the data necessary for +configuring a registered Attestation Service instance with a cluster in the +environment. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Services.CreateSpec.SourceType) – Source of truth for the configuration of the Attestation Service. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • service (str) – The service’s unique ID. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +This attribute is optional and it is only relevant when the value +of type is Services.CreateSpec.SourceType.SERVICE.

    • +

  • trust_authority_cluster (str) – The attestation cluster’s unique ID. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Services.CreateSpec.SourceType.CLUSTER.

    • +
+
+
+
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Services.CreateSpec.SourceType class specifies the source of truth +the Attestation Service will use for its configuration. This enumeration +was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+CLUSTER = SourceType(string='CLUSTER')
+

The Attestation Service will be configured based on an ID of a whole +attestation cluster. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SERVICE = SourceType(string='SERVICE')
+

The Attestation Service will be configured based on an ID of an specific +Attestation Service. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class FilterSpec(services=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.FilterSpec class contains the data necessary for +identifying a Attestation service instance. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • services (set of str or None) – A set of IDs by which to filter the services. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +If None, the services will not be filtered by ID.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – The service’s address. This attribute was added in vSphere API +7.0.0.0. +If None, the services will not be filtered by address.

    • +

  • group (set of str or None) – The group specifies the Key Provider Service instances can accept +reports issued by this Attestation Service instance. This attribute +was added in vSphere API 7.0.0.0. +If None, the services will not be filtered by group.

    • +

  • trust_authority_cluster (set of str or None) – The cluster specifies the Trust Authority Cluster this Attestation +Service instance belongs to. This attribute was added in vSphere +API 7.0.0.0. +If None, the services will not be filtered by +trustAuthorityCluster.

    • +
+
+
+
+ +
+
+class Info(address=None, trusted_ca=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Info class contains all the stored information about a +registered Attestation Service instance that is configured for a cluster. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • group (str) – The group determines the Key Provider Service instances can accept +reports issued by this Attestation Service instance. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Attestation +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(service=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Summary class contains basic information about a +registered Attestation Service instance that is configured for a cluster. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • service (str) – The service’s unique identifier. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • group (str) – The group specifies the Key Provider Service instances can accept +reports issued by this Attestation Service instance. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Attestation +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+create_task(cluster, spec)
+

Configures the cluster to use a the given registered Attestation +Service. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Services.CreateSpec) – Describes the registered instance of the Attestation Service

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the Attestation Service is already configured for this cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +for any other error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the CreateSpec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster ID is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if all the hosts in the cluster do not have VMware vSphere Trust +Authority enabled license.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+delete_task(cluster, service)
+

Removes the Attestation Service instance from the configuration of the +given cluster. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – the unique ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • service (str) – the registered Attestation Service instance unique identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Attestation Service instance or the cluster are not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+get(cluster, service)
+

Returns detailed information about the given registered Attestation +Service instance that is configured for the given cluster. This method +was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • service (str) – The ID of the service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service.

    • +
+
+
Return type
+

Services.Info

+
+
Returns
+

Detailed information about the specified Attestation Service +configured for the given cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster or the service ID is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires System.View.

    • +
+
+
+
+ +
+
+list(cluster, spec=None)
+

Returns the basic information about all configured Attestation Service +instances used by this cluster. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Services.FilterSpec or None) – Only return services matching the filters. +If {\@term.unset} return all services.

    • +
+
+
Return type
+

list of Services.Summary

+
+
Returns
+

Basic information about all configured Attestation Service +instances used by this cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster ID is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires System.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.ServicesAppliedConfig(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ServicesAppliedConfig class provides information about the +aggregate health of the applied Attestation Service configuration on the +Trusted Clusters. The desired state of the Attestation Service is stored +within vCenter, while the applied configuration is stored on the hosts in +the cluster. The ServicesAppliedConfig class is available for all +clusters, not only Trusted Clusters. In such cases empty desired state is +assumed, e.g. when an applied Attestation Service configuration is found +outside of a Trusted Cluster it is considered an +ServicesAppliedConfig.Health.ERROR. The ServicesAppliedConfig +class is able to put the applied Attestation Service configuration into a +consistent state when individual host configurations have diverged from the +desired state. This class was added in vSphere API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(health=None, address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.FilterSpec class specifies the matching +criteria to be applied when filtering out ServicesAppliedConfig.Summary +structures from the collection returned by the list method. Only +ServicesAppliedConfig.Summary structures containing the values +specified in this structure will be returned from the list method. If +multiple members of the filter spec are set, all of them must match for a +result to be filtered out and returned. This class was added in vSphere API +7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (set of ServicesAppliedConfig.Health or None) – The health of the applied Attestation Service configuration. This +attribute was added in vSphere API 7.0.1.0. +If None, no filtration will be performed by health.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – The network address of the Attestation Service configured for use +in the Trusted Cluster. This attribute was added in vSphere API +7.0.1.0. +If None, no filtration will be performed by network address.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ServicesAppliedConfig.Health class is an indicator for the +consistency of the applied Attestation Service configuration in a cluster +with respect to the desired state. This enumeration was added in vSphere +API 7.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

The applied Attestation Service configuration has diverged from the desired +state. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+NONE = Health(string='NONE')
+

The consistency of the applied configuration is unknown. This class +attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+OK = Health(string='OK')
+

The applied Attestation Service configuration is consistent with the +desired state. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+ +
+
+class Info(health=None, address=None, service=None, groups=None, trustedc_as=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.Info class contains detailed information +about an applied Attestation Service configuration in a Trusted cluster. +This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (ServicesAppliedConfig.Health) – A health value which indicates whether the configuration applied to +the cluster differs from the desired state. This attribute was +added in vSphere API 7.0.1.0.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The network address of the Attestation Service configured for use +in the Trusted Cluster. This attribute was added in vSphere API +7.0.1.0.

    • +

  • service (str or None) – The unique identifier of an Attestation Service configuration from +the desired state. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +If None, this Attestation Service is not registered within this +vCenter and thus the applied configuration is not present in the +desired state.

    • +

  • groups (set of str) – The set of distinct groups found on the hosts in the cluster which +differ from the desired state. This attribute was added in vSphere +API 7.0.1.0.

    • +

  • trustedc_as (list of com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – A list of distinct trusted CA chains found on the hosts in the +cluster which differ from the desired state. This attribute was +added in vSphere API 7.0.1.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) – Details regarding the health. When the +ServicesAppliedConfig.Health is not +ServicesAppliedConfig.Health.OK, this member will provide a +detailed description of the issues present. This attribute was +added in vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class Summary(health=None, address=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.Summary class contains basic information +about the aggregated health status for a service. This class was added in +vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (ServicesAppliedConfig.Health) – The health value indicates whether the configuration applied to the +cluster differs from the desired state. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The network address of the Attestation Service configured for use +in the Trusted Cluster. This attribute was added in vSphere API +7.0.1.0.

    • +

  • service (str or None) – The unique identifier of an Attestation Service configuration from +the desired state. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.attestation.Service. +If None, this Attestation Service is not registered within this +vCenter and thus the applied configuration is not present in the +desired state.

    • +
+
+
+
+ +
+
+delete_task(cluster)
+

Delete the Attestation Service configuration that has been applied to +the given cluster. This method has no affect on the desired state, it +only removes applied Attestation Service configuration from any Trusted +Hosts within the given cluster. This method was added in vSphere API +7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get_task(cluster, address)
+

Returns detailed information about the health of the specified +Attestation Service configuration applied to the cluster with respect +to the desired state. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter or if no service corresponding to the given address is +found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+list_task(cluster, spec=None)
+

Returns basic information about the health of all Attestation Service +configurations applied to the cluster with respect to the desired +state. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (ServicesAppliedConfig.FilterSpec or None) – The specification for the subset of results desired to be returned. +If {\@term.unset} all results are returned.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+update_task(cluster)
+

Update the applied Attestation Service configuration on the given +Trusted Cluster to be consistent with the desired state. This method +has no affect on the desired state, apart from it being used as a +reference point for the remediation. This method was added in vSphere +API 7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the Trusted Cluster against which the operation will be +executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module

+

The com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client +module provides classes for configuring Key Provider Services for Trusted +Clusters.

+
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Services class manages the Key Provider Service instances a Trusted +Cluster is configured to use. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(type=None, service=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.CreateSpec class contains the data necessary for +configuring a registered Key Provider Service instance with a cluster in +the environment. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Services.CreateSpec.SourceType) – Source of truth for the configuration of the Key Provider Service. +This attribute was added in vSphere API 7.0.0.0.

    • +

  • service (str) – The service’s unique ID. This attribute was added in vSphere API +7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. +This attribute is optional and it is only relevant when the value +of type is Services.CreateSpec.SourceType.SERVICE.

    • +

  • trust_authority_cluster (str) – The attestation cluster’s unique ID. This attribute was added in +vSphere API 7.0.0.0. +This attribute is optional and it is only relevant when the value +of type is Services.CreateSpec.SourceType.CLUSTER.

    • +
+
+
+
+
+class SourceType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Services.CreateSpec.SourceType class specifies source of truth the +Key Provider Service will use for its configuration. This enumeration was +added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the SourceType instance.

+
+
+
+
+CLUSTER = SourceType(string='CLUSTER')
+

The Key Provider Service will be configured based on an ID of a whole +attestation cluster. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SERVICE = SourceType(string='SERVICE')
+

The Key Provider Service will be configured based on an ID of an specific +Key Provider Service. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+ +
+ +
+
+class FilterSpec(services=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.FilterSpec class contains the data necessary for +identifying a Key Provider service instance. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • services (set of str or None) – A set of IDs by which to filter the services. This attribute was +added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will contain identifiers for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. +If None, the services will not be filtered by ID.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – The service’s address. This attribute was added in vSphere API +7.0.0.0. +If None, the services will not be filtered by address.

    • +

  • group (set of str or None) – The group determines the Attestation Service instances this Key +Provider Service can accept reports from. This attribute was added +in vSphere API 7.0.0.0. +If None, the services will not be filtered by group.

    • +

  • trust_authority_cluster (set of str or None) – The cluster specifies the Trust Authority Cluster this Key Provider +Service instance belongs to. This attribute was added in vSphere +API 7.0.0.0. +If None, the services will not be filtered by +trustAuthorityCluster.

    • +
+
+
+
+ +
+
+class Info(address=None, trusted_ca=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Info class contains all the stored information about a +registered Key Provider Service instance that is configured for a cluster. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • trusted_ca (com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – The service’s TLS certificate chain. This attribute was added in +vSphere API 7.0.0.0.

    • +

  • group (str) – The group determines the Attestation Service instances this Key +Provider Service can accept reports from. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Key Provider +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+class Summary(service=None, address=None, group=None, trust_authority_cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Services.Summary class contains basic information about a +registered Key Provider Service instance that is configured for a cluster. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • service (str) – The service’s unique identifier. This attribute was added in +vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The service’s address. This attribute was added in vSphere API +7.0.0.0.

    • +

  • group (str) – The group determines the Attestation Service instances this Key +Provider Service can accept reports from. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • trust_authority_cluster (str) – The cluster specifies the Trust Authority Cluster this Key Provider +Service belongs to. This attribute was added in vSphere API +7.0.0.0.

    • +
+
+
+
+ +
+
+create_task(cluster, spec)
+

Configures the cluster to use a the given registered Key Provider +Service. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Services.CreateSpec) – Describes the registered instance of the Key Provider Service

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the Key Provider Service is already configured for this cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +for any other error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the CreateSpec is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster ID is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if all the hosts in the cluster do not have VMware vSphere Trust +Authority enabled license.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+delete_task(cluster, service)
+

Removes the Key Provider Service instance from the configuration of the +given cluster. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – the unique ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • service (str) – the registered Key Provider Service instance unique identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the Key Provider Service instance or the cluster are not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+
+get(cluster, service)
+

Returns detailed information about the given Key Provider Service +instance used by the given cluster. This method was added in vSphere +API 7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • service (str) – The ID of the service. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service.

    • +
+
+
Return type
+

Services.Info

+
+
Returns
+

Detailed information about the given Key Provider Service instance +used by the given cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster or the service ID is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires System.View.

    • +
+
+
+
+ +
+
+list(cluster, spec=None)
+

Returns basic information about all configured Key Provider Service +instances used by this cluster. This method was added in vSphere API +7.0.0.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (Services.FilterSpec or None) – Only return services matching the filters. +If {\@term.unset} return all services.

    • +
+
+
Return type
+

list of Services.Summary

+
+
Returns
+

basic information about all configured Key Provider Service +instances used by this cluster

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the cluster ID is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires TrustedAdmin.ReadTrustedHosts.

    • +

  • The resource ClusterComputeResource referenced by the +parameter cluster requires System.View.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.ServicesAppliedConfig(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The ServicesAppliedConfig class provides information about the +aggregate health of the applied Key Provider Service configuration on the +Trusted Clusters. The desired state of the Key Provider Service is stored +within vCenter, while the applied configuration is stored on the hosts in +the cluster. The ServicesAppliedConfig class is available for all +clusters, not only Trusted Clusters. In such cases empty desired state is +assumed, e.g. when an applied Key Provider Service configuration is found +outside of a Trusted Cluster it is considered an +ServicesAppliedConfig.Health.ERROR. The ServicesAppliedConfig +class is able to put the applied Key Provider Service configuration into a +consistent state when individual host configurations have diverged from the +desired state. This class was added in vSphere API 7.0.1.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FilterSpec(health=None, address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.FilterSpec class specifies the matching +criteria to be applied when filtering out ServicesAppliedConfig.Summary +structures from the collection returned by the list method. Only +ServicesAppliedConfig.Summary structures containing the values +specified in this structure will be returned from the list method. If +multiple members of the filter spec are set, all of them must match for a +result to be filtered out and returned. This class was added in vSphere API +7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (set of ServicesAppliedConfig.Health or None) – The health of the applied Key Provider Service configuration. This +attribute was added in vSphere API 7.0.1.0. +If None, no filtration will be performed by health.

    • +

  • address (list of com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress or None) – The network address of the Key Provider Service configured for use +in the Trusted Cluster. This attribute was added in vSphere API +7.0.1.0. +If None, no filtration will be performed by network address.

    • +
+
+
+
+ +
+
+class Health(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ServicesAppliedConfig.Health class is an indicator for the +consistency of the applied Key Provider Service configuration in a cluster +with respect to the desired state. This enumeration was added in vSphere +API 7.0.1.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Health instance.

+
+
+
+
+ERROR = Health(string='ERROR')
+

The applied Key Provider Service configuration has diverged from the +desired state. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+NONE = Health(string='NONE')
+

The consistency of the applied configuration is unknown. This class +attribute was added in vSphere API 7.0.1.0.

+
+ +
+
+OK = Health(string='OK')
+

The applied Key Provider Service configuration is consistent with the +desired state. This class attribute was added in vSphere API 7.0.1.0.

+
+ +
+ +
+
+class Info(health=None, address=None, service=None, groups=None, trustedc_as=None, details=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.Info class contains detailed information +about an applied Key Provider Service configuration in a Trusted cluster. +This class was added in vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (ServicesAppliedConfig.Health) – A health value which indicates whether the configuration applied to +the cluster differs from the desired state. This attribute was +added in vSphere API 7.0.1.0.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The network address of the Key Provider Service configured for use +in the Trusted Cluster. This attribute was added in vSphere API +7.0.1.0.

    • +

  • service (str or None) – The unique identifier of a Key Provider Service configuration from +the desired state. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. +If None, this Key Provider Service is not registered within this +vCenter and thus the applied configuration is not present in the +desired state.

    • +

  • groups (set of str) – The set of distinct groups found on the hosts in the cluster which +differ from the desired state. This attribute was added in vSphere +API 7.0.1.0.

    • +

  • trustedc_as (list of com.vmware.vcenter.trusted_infrastructure_client.X509CertChain) – A list of distinct trusted CA chains found on the hosts in the +cluster which differ from the desired state. This attribute was +added in vSphere API 7.0.1.0.

    • +

  • details (list of com.vmware.vapi.std_client.LocalizableMessage) – Details regarding the health. When the +ServicesAppliedConfig.Health is not +ServicesAppliedConfig.Health.OK, this member will provide a +detailed description of the issues present. This attribute was +added in vSphere API 7.0.1.0.

    • +
+
+
+
+ +
+
+class Summary(health=None, address=None, service=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ServicesAppliedConfig.Summary class contains basic information +about the aggregated health status for a service. This class was added in +vSphere API 7.0.1.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • health (ServicesAppliedConfig.Health) – The health value indicates whether the configuration applied to the +cluster differs from the desired state. This attribute was added in +vSphere API 7.0.1.0.

    • +

  • address (com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress) – The network address of the Key Provider Service configured for use +in the Trusted Cluster. This attribute was added in vSphere API +7.0.1.0.

    • +

  • service (str or None) – The unique identifier of a Key Provider Service configuration from +the desired state. This attribute was added in vSphere API 7.0.1.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. When +methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: +com.vmware.vcenter.trusted_infrastructure.kms.Service. +If None, this Key Provider Service is not registered within this +vCenter and thus the applied configuration is not present in the +desired state.

    • +
+
+
+
+ +
+
+delete_task(cluster)
+

Delete the Key Provider Service configuration that has been applied to +the given cluster. This method has no affect on the desired state, it +only removes applied Key Provider Service configuration from any +Trusted Hosts within the given cluster. This method was added in +vSphere API 7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+get_task(cluster, address)
+

Returns detailed information about the health of the specified Key +Provider Service configuration applied to the cluster with respect to +the desired state. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter or if no service corresponding to the given address is +found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+list_task(cluster, spec=None)
+

Returns basic information about the health of all Key Provider Service +configurations applied to the cluster with respect to the desired +state. This method was added in vSphere API 7.0.1.0.

+
+
Parameters
+
    +

  • cluster (str) – The ID of the cluster against which the operation will be executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

    • +

  • spec (ServicesAppliedConfig.FilterSpec or None) – The specification for the subset of results desired to be returned. +If {\@term.unset} all results are returned.

    • +
+
+
Return type
+

+
class
+

vmware.vapi.stdlib.client.task.Task

+
+
+

+
+
Returns
+

Task instance

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+
+update_task(cluster)
+

Update the applied Key Provider Service configuration on the given +Trusted Cluster to be consistent with the desired state. This method +has no affect on the desired state, apart from it being used as a +reference point for the remediation. This method was added in vSphere +API 7.0.1.0.

+
+
Parameters
+

cluster (str) – The ID of the Trusted Cluster against which the operation will be +executed. +The parameter must be an identifier for the resource type: +ClusterComputeResource.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if there is a generic error.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the cluster ID is empty

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if no cluster corresponding to the given ID is found within this +vCenter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if there are ongoing mutating operations.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the caller is not authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.vcha.html b/vsphere/8.0.2.0/com.vmware.vcenter.vcha.html new file mode 100644 index 00000000..212a8f3c --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.vcha.html @@ -0,0 +1,895 @@ + + + + + + + com.vmware.vcenter.vcha package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.vcha package

+
+

Submodules

+
+
+

com.vmware.vcenter.vcha.cluster_client module

+

The com.vmware.vcenter.vcha.cluster_client module provides classes for +redeploying and monitoring a vCenter High Availability (VCHA) Cluster after a +successful initial deployment.

+
+
+class com.vmware.vcenter.vcha.cluster_client.Active(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Active class provides methods to get information related to the +active vCenter High Availability (VCHA) node. This class was added in +vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(management=None, ha=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Active.Info class contains the network and placement information of +the active node of a VCHA Cluster. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • management (com.vmware.vcenter.vcha_client.IpSpec) – IP specification for the Management network. This attribute was +added in vSphere API 6.7.1.

    • +

  • ha (com.vmware.vcenter.vcha_client.IpSpec or None) – IP specification for the HA network. This attribute was added in +vSphere API 6.7.1. +If None, then the second NIC of the Active Node of the VCHA cluster +is not configured.

    • +

  • placement (com.vmware.vcenter.vcha_client.PlacementInfo or None) – Contains the placement information of the active node. This +attribute was added in vSphere API 6.7.1. +If None, the request specified that placement information of the +active node should not be included.

    • +
+
+
+
+ +
+
+get(vc_spec=None, partial=None)
+

Retrieves information about the active node of a VCHA cluster. This +method was added in vSphere API 6.7.1.

+
+
Parameters
+
    +

  • vc_spec (com.vmware.vcenter.vcha_client.CredentialsSpec or None) – Contains active node’s management vCenter server credentials. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • partial (bool or None) – If true, then return only the information that does not require +connecting to the Active vCenter Server. +If false or unset, then return all the information. +If None, then return all the information.

    • +
+
+
Return type
+

Active.Info

+
+
Returns
+

Info Information about the VCHA network and placement of the active +node.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authentincating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation.

+
    +

  • If partial is false or unset, then the operation execution +requires the Global.VCServer privilege.

    • +

  • If partial is true, then the operation execution requires the +System.Read privilege.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +com.vmware.vcenter.vcha_client.CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementConfiguration +If the active node is on more than one datastore.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the active virtual machine is not managed by the specified +vCenter server for the active node.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If the management interface IP address assignment is not static.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vcha.cluster_client.DeploymentType(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The DeploymentType class provides methods to get the deployment type of a +vCenter High Availability Cluster (VCHA Cluster). This class was added in +vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(deployment_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DeploymentType.Info class contains the deployment type of the VCHA +Cluster. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

deployment_type (DeploymentType.Type) – Identifies the deployment type of the VCHA cluster. This attribute +was added in vSphere API 6.7.1.

+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The DeploymentType.Type class defines the possible deployment types for +a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+AUTO = Type(string='AUTO')
+

VCHA Cluster was deployed automatically. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+MANUAL = Type(string='MANUAL')
+

VCHA Cluster was deployed manually. This class attribute was added in +vSphere API 6.7.1.

+
+ +
+
+NONE = Type(string='NONE')
+

VCHA Cluster is not configured. This class attribute was added in vSphere +API 6.7.1.

+
+ +
+ +
+
+get()
+

Retrieves the deployment type of a VCHA cluster. This method was added +in vSphere API 6.7.1.

+
+
Return type
+

DeploymentType.Info

+
+
Returns
+

Info structure containing the deployment type information of the +the VCHA cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vcha.cluster_client.Mode(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Mode class provides methods to manage the operating mode of a vCenter +High Availability Cluster (VCHA Cluster). This class was added in vSphere +API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class ClusterMode(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Mode.ClusterMode class defines the possible modes for a VCHA +Cluster. This enumeration was added in vSphere API 6.7.1.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ClusterMode instance.

+
+
+
+
+DISABLED = ClusterMode(string='DISABLED')
+

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.

+
+ +
+
+ENABLED = ClusterMode(string='ENABLED')
+

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.

+
+ +
+
+MAINTENANCE = ClusterMode(string='MAINTENANCE')
+

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.

+
+ +
+ +
+
+class Info(mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Mode.Info class contains the mode of the VCHA Cluster. This class +was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

mode (Mode.ClusterMode) – Identifies the mode of the VCHA cluster. This attribute was added +in vSphere API 6.7.1.

+
+
+
+ +
+
+get()
+

Retrieves the current mode of a VCHA cluster. This method was added in +vSphere API 6.7.1.

+
+
Return type
+

Mode.Info

+
+
Returns
+

Info structure containing the mode of the the VCHA cluster.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the VCHA cluster is not configured.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the System.Read privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+set_task(mode)
+

Manipulates the mode of a VCHA Cluster. Following mode transitions are +allowed: +enabled -> disabled - Allowed only in healthy and degraded states. +enabled -> maintenance - Allowed only in healthy state. +disabled -> enabled - Allowed only in healthy state. +maintenance -> enabled - Allowed only in healthy state with all nodes +are running the same version. +maintenance -> disabled - Allowed only in healthy state with all nodes +are running the same version. +All other transitions are not allowed.

+

VCHA Cluster configuration remains intact in any of the cluster modes.. +This method was added in vSphere API 6.7.1.

+
+
Parameters
+

mode (Mode.ClusterMode) – Clustermode to change the VCHA cluster mode to.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vcha.cluster_client.Passive(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Passive class provides methods to validate a passive’s placement +configuration and redeploy the passive node in a vCenter High Availability +(VCHA) cluster. This class was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckResult(warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Passive.CheckResult class contains the warnings and errors that +will occur during the clone operation. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class CheckSpec(vc_spec=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Passive.CheckSpec class contains placement information for +validation. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vc_spec (com.vmware.vcenter.vcha_client.CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. +This attribute was added in vSphere API 6.7.1. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • placement (com.vmware.vcenter.vcha_client.PlacementSpec) – Contains the node’s placement information for validation. This +attribute was added in vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class RedeploySpec(vc_spec=None, placement=None, ha_ip=None, failover_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Passive.RedeploySpec class contains the redeploy specification. +This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vc_spec (com.vmware.vcenter.vcha_client.CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. +This attribute was added in vSphere API 6.7.1. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • placement (com.vmware.vcenter.vcha_client.PlacementSpec) – Contains the node’s placement information. This attribute was added +in vSphere API 6.7.1.

    • +

  • ha_ip (com.vmware.vcenter.vcha_client.IpSpec or None) – Contains the VCHA HA network configuration of the node. All cluster +communication (state replication, heartbeat, cluster messages) +happens over this network. This attribute was added in vSphere API +6.7.1. +If None, then the stored network configuration for the VCHA HA +network for the passive node will be used.

    • +

  • failover_ip (com.vmware.vcenter.vcha_client.IpSpec or None) – Failover IP address that this node must assume after the failover +to serve client requests. This attribute was added in vSphere API +6.7.1. +If None, then the public IP address of the Active vCenter Server is +assumed.

    • +
+
+
+
+ +
+
+check(spec)
+

Validates the specified passive node’s placement configuration. This +method was added in vSphere API 6.7.1.

+
+
Parameters
+

spec (Passive.CheckSpec) – Contains the passive node’s placement specification.

+
+
Return type
+

Passive.CheckResult

+
+
Returns
+

CheckResult structure containing errors and warnings.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authentincating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the specified resource spec is deemed invalid for the clone +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +com.vmware.vcenter.vcha_client.CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the active virtual machine is not managed by the specified +vCenter server for the active node.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementConfiguration +If the active node is on more than one datastore.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the clone operation is not allowed in the current state of the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+redeploy_task(spec)
+

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.

+
+
Parameters
+

spec (Passive.RedeploySpec) – Contains the passive node’s redeploy specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authentincating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +com.vmware.vcenter.vcha_client.CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vcha.cluster_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.vcha.cluster_client.Witness(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Witness class provides methods to validate a witness’s placement +configuration and redeploy the witness node in a vCenter High Availability +(VCHA) cluster. This class was added in vSphere API 6.7.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckResult(warnings=None, errors=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Witness.CheckResult class contains the warnings and errors that +will occur during the clone operation. This class was added in vSphere API +6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+class CheckSpec(vc_spec=None, placement=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Witness.CheckSpec class contains placement information for +validation. This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vc_spec (com.vmware.vcenter.vcha_client.CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. +This attribute was added in vSphere API 6.7.1. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • placement (com.vmware.vcenter.vcha_client.PlacementSpec) – Contains the node’s placement information for validation. This +attribute was added in vSphere API 6.7.1.

    • +
+
+
+
+ +
+
+class RedeploySpec(vc_spec=None, placement=None, ha_ip=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Witness.RedeploySpec class contains the redeploy specification. +This class was added in vSphere API 6.7.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vc_spec (com.vmware.vcenter.vcha_client.CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. +This attribute was added in vSphere API 6.7.1. +If None, then the active vCenter Server instance is assumed to be +either self-managed or else in enhanced linked mode and managed by +a linked vCenter Server instance.

    • +

  • placement (com.vmware.vcenter.vcha_client.PlacementSpec) – Contains the node’s placement information. This attribute was added +in vSphere API 6.7.1.

    • +

  • ha_ip (com.vmware.vcenter.vcha_client.IpSpec or None) – Contains the VCHA HA network configuration of the node. All cluster +communication (state replication, heartbeat, cluster messages) +happens over this network. This attribute was added in vSphere API +6.7.1. +If None, then the stored network configuration for the VCHA HA +network for the witness node will be used.

    • +
+
+
+
+ +
+
+check(spec)
+

Validates the specified witness node’s placement configuration. This +method was added in vSphere API 6.7.1.

+
+
Parameters
+

spec (Witness.CheckSpec) – Contains the witness node’s placement specification.

+
+
Return type
+

Witness.CheckResult

+
+
Returns
+

CheckResult structure containing errors and warnings.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authentincating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the specified resource spec is deemed invalid for the clone +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +com.vmware.vcenter.vcha_client.CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the active virtual machine is not managed by the specified +vCenter server for the active node.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidElementConfiguration +If the active node is on more than one datastore.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +If the clone operation is not allowed in the current state of the +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+
+redeploy_task(spec)
+

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.

+
+
Parameters
+

spec (Witness.RedeploySpec) – Contains the witness node’s redeploy specification.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If the credentials provided for authentincating with the active +node’s management vCenter server are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +If the user has insufficient privilege to perform the operation. +Operation execution requires the Global.VCServer privilege.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnverifiedPeer +If the SSL certificate of the management vCenter server cannot be +validated. +The value of the data attribute of +com.vmware.vapi.std.errors_client.Error will be a class +that contains all the attributes defined in +com.vmware.vcenter.vcha_client.CertificateInfo.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +If any other error occurs.

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.vm.guest.html b/vsphere/8.0.2.0/com.vmware.vcenter.vm.guest.html new file mode 100644 index 00000000..66314bdb --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.vm.guest.html @@ -0,0 +1,2381 @@ + + + + + + + com.vmware.vcenter.vm.guest package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+ +
+

com.vmware.vcenter.vm.guest package

+
+

Submodules

+
+
+

com.vmware.vcenter.vm.guest.filesystem_client module

+

The com.vmware.vcenter.vm.guest.filesystem_client module provides classes +for dealing with the filesystem of the guest operating system.

+
+
+class com.vmware.vcenter.vm.guest.filesystem_client.Directories(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Directories class provides methods to manage directories in the +guest filesystem. This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+create(vm, credentials, path, create_parents=None)
+

Creates a directory in the guest operating system.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the directory to be created.

    • +

  • create_parents (bool or None) – Whether any parent directories should be created. If any failure +occurs, some parent directories could be left behind. +If None parent directories are not created.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if path already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path does not exist and create_parents is not set. The +value of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be created because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+
+create_temporary(vm, credentials, prefix, suffix, parent_path=None)
+

Creates a temporary directory.

+

Creates a new unique temporary directory for the user to use as needed. +The guest operating system may clean up the directory after a guest +specific amount of time if parent_path is not set, or the user can +remove the directory when no longer needed.

+

The new directory name will be created in a guest-specific format using +prefix, a guest generated string and suffix in parent_path.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • prefix (str) – The prefix to be given to the new temporary directory.

    • +

  • suffix (str) – The suffix to be given to the new temporary directory.

    • +

  • parent_path (str or None) – The complete path to the directory in which to create the new +directory. +Directory If None a guest-specific default will be used.

    • +
+
+
Return type
+

str

+
+
Returns
+

The absolute path of the temporary directory that is created.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if parent_path is not a directory. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if parent_path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if parent_path is set and does not exist. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if parent_path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if a file cannot be created because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+
+delete(vm, credentials, path, recursive=None)
+

Deletes a directory in the guest operating system.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the directory to be deleted.

    • +

  • recursive (bool or None) – If true, all files and subdirectories are also deleted. If false, +the directory must be empty for the operation to succeed. +If None, any directory content is not deleted.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is not a directory. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if path has content and recursive is None.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be deleted because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+
+move(vm, credentials, path, new_path)
+

Renames a directory in the guest.

+

Renames the directory, or copies and deletes the old contents as +required by the underlying filsystem.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the directory to be moved.

    • +

  • new_path (str) – The complete path to where the directory is moved or its new name. +It cannot be a path to an existing directory or an existing file.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if new_path already exists.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is not a directory. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if new_path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the parent directory of new_path does not exist. The value +of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if a path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if a path cannot be renamed or moved because the guest +authentication will not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ErrorReason class defines the reasons a file or directory operation +failed. This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ErrorReason instance.

+
+
+
+
+DIRECTORY_NOT_EMPTY = ErrorReason(string='DIRECTORY_NOT_EMPTY')
+

Directory not empty. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+FILE_NOT_FOUND = ErrorReason(string='FILE_NOT_FOUND')
+

The file is not found. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+
+FILE_TOO_LARGE = ErrorReason(string='FILE_TOO_LARGE')
+

The file is too large. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+
+NOT_A_DIRECTORY = ErrorReason(string='NOT_A_DIRECTORY')
+

The argument is not a directory. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+NOT_A_FILE = ErrorReason(string='NOT_A_FILE')
+

An argument is not a file. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+
+NO_DISK_SPACE = ErrorReason(string='NO_DISK_SPACE')
+

There is insufficent disk space. This class attribute was added in vSphere +API 7.0.2.0.

+
+ +
+
+PATH_TOO_LONG = ErrorReason(string='PATH_TOO_LONG')
+

The file path is too long. This class attribute was added in vSphere API +7.0.2.0.

+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails(reason=None, file_path=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The FileErrorDetails class describes additional error information for +file and directory operations. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • reason (ErrorReason) – The reason for the error. This attribute was added in vSphere API +7.0.2.0.

    • +

  • file_path (str) – The file path associated with the error. This attribute was added +in vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.guest.filesystem_client.Files(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Files class provides methods to manage the files in the guest +filesystem. This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class FileAttributesInfo(last_modified=None, last_accessed=None, symlink_target=None, filesystem_family=None, win_attributes=None, posix_attributes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.FileAttributesInfo class describes the attributes of a file +in a guest operating system. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • last_modified (datetime.datetime) – The date and time the file was last modified. This attribute was +added in vSphere API 7.0.2.0.

    • +

  • last_accessed (datetime.datetime) – The date and time the file was last accessed. This attribute was +added in vSphere API 7.0.2.0.

    • +

  • symlink_target (str or None) – The target for the file if it’s a symbolic link. This is currently +only set for Posix guest operating systems, but may be supported in +the future on Windows guest operating systems that support symbolic +links. This attribute was added in vSphere API 7.0.2.0. +Set if the file is a symbolic link.

    • +

  • filesystem_family (Files.FilesystemFamily) – The type of guest filesystem. This attribute was added in vSphere +API 7.0.2.0.

    • +

  • win_attributes (Files.WindowsFileAttributesInfo) – Windows-specific file information. This attribute was added in +vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of filesystemFamily is Files.FilesystemFamily.WINDOWS.

    • +

  • posix_attributes (Files.PosixFileAttributesInfo) – Posix-specific file information. This attribute was added in +vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of filesystemFamily is Files.FilesystemFamily.POSIX.

    • +
+
+
+
+ +
+
+class FileAttributesUpdateSpec(last_modified=None, last_accessed=None, windows=None, posix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

File attributes used for updating an existing file with +Files.update(). This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • last_modified (datetime.datetime or None) – The date and time the file was last modified. This attribute was +added in vSphere API 7.0.2.0. +If None the value will not be changed.

    • +

  • last_accessed (datetime.datetime or None) – The date and time the file was last accessed. This attribute was +added in vSphere API 7.0.2.0. +If None the value will not be changed.

    • +

  • windows (Files.WindowsFileAttributesUpdateSpec or None) – Windows-specific file update information. This attribute was added +in vSphere API 7.0.2.0. +Set if the guest operating system is Windows.

    • +

  • posix (Files.PosixFileAttributesUpdateSpec or None) – Posix-specific file update information. This attribute was added in +vSphere API 7.0.2.0. +Set if the guest operating system is Posix.

    • +
+
+
+
+ +
+
+class FilesystemFamily(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Files.FilesystemFamily class defines the types of guest operating +fllesystem. This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the FilesystemFamily instance.

+
+
+
+
+POSIX = FilesystemFamily(string='POSIX')
+

Linux, Solaris, etc. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+WINDOWS = FilesystemFamily(string='WINDOWS')
+

The guest OS is a Windows variant. This class attribute was added in +vSphere API 7.0.2.0.

+
+ +
+ +
+
+class FilterSpec(match_pattern=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.FilterSpec class contains information used to filter the +results when listing files (see Files.list()). This class was added +in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

match_pattern (str or None) – The perl-compatible regular expression used to filter the returned +files. This attribute was added in vSphere API 7.0.2.0. +If None the pattern ‘.*’ (match everything) is used.

+
+
+
+ +
+
+class Info(type=None, size=None, attributes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.Info class describes a file or directory in the guest +operating system. Returned by Files.get(). This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Files.Type) – The type of file. This attribute was added in vSphere API 7.0.2.0.

    • +

  • size (long) – The file size in bytes. This attribute was added in vSphere API +7.0.2.0.

    • +

  • attributes (Files.FileAttributesInfo) – Attributes of a file. This attribute was added in vSphere API +7.0.2.0.

    • +
+
+
+
+ +
+
+class IterationSpec(size=None, index=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.IterationSpec class contains attributes used to break results +into pages when listing files. See Files.list()). This class was +added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size (long or None) – Specifies the maximum number of results to return. This attribute +was added in vSphere API 7.0.2.0. +If None information about at most 50 files will be returned.

    • +

  • index (long or None) – Which result to start the list with. If this value exceeds the +number of results, an empty list will be returned. This attribute +was added in vSphere API 7.0.2.0. +If None, the start of the list of files will be returned.

    • +
+
+
+
+ +
+
+class LastIterationStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The last status for the iterator. A field of this type is returned as part +of the result and indicates to the caller of the API whether it can +continue to make requests for more data. The last status only reports on +the state of the iteration at the time data was last returned. As a result, +it not does guarantee if the next call will succeed in getting more data or +not. Failures to retrieve results will be returned as Error responses. +These last statuses are only returned when the iterator is operating as +expected. This enumeration was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the LastIterationStatus instance.

+
+
+
+
+END_OF_DATA = LastIterationStatus(string='END_OF_DATA')
+

Iterator has finished iterating through its inventory. There are currently +no more entities to return and the caller can terminate iteration. If the +iterator returned some data, the marker may be set to allow the iterator to +continue from where it left off when additional data does become available. +This value is used to indicate that all available data has been returned by +the iterator. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+READY = LastIterationStatus(string='READY')
+

Iterator has more data pending and is ready to provide it. The caller can +request the next page of data at any time. The number of results returned +may be less than the requested size. In other words, the iterator may not +fill the page. The iterator has returned at least 1 result. This class +attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class ListResult(files=None, total=None, start_index=None, end_index=None, status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.ListResult class describes the results of a +Files.list() method. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • files (list of Files.Summary) – A list of Files.Summary classes containing information for +all the matching files. This attribute was added in vSphere API +7.0.2.0.

    • +

  • total (long) – The total number of results from the Files.list(). This is a +hint to the user of the iterator regarding how many items are +available to be retrieved. The total could change if the inventory +of items are being changed. This attribute was added in vSphere API +7.0.2.0.

    • +

  • start_index (long or None) – Positional index into the logical item list of the first item +returned in the list of results. The first item in the logical item +list has an index of 0. This is a hint to the user of the iterator +regarding the logical position in the iteration. For example, this +can be used to display to the user which page of the iteration is +being shown. The total could change if the inventory of items are +being changed. This attribute was added in vSphere API 7.0.2.0. +If None no items were returned.

    • +

  • end_index (long or None) – Positional index into the logical item list of the last item +returned in the list of results. The first item in the logical item +list has an index of 0. This is a hint to the user of the iterator +regarding the logical position in the iteration. For example, this +can be used to display to the user which page of the iteration is +being shown. The total could change if the inventory of items are +being changed. This attribute was added in vSphere API 7.0.2.0. +If None no items were returned.

    • +

  • status (Files.LastIterationStatus) – The last status for the iterator that indicates whether any more +results can be expected if the caller continues to make requests +for more data using the iterator. This attribute was added in +vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class PosixFileAttributesInfo(owner=None, group=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.PosixFileAttributesInfo class describes information about +file attributes specific to Posix Guest operating systems. This class was +added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • owner (long) – The owner ID. This attribute was added in vSphere API 7.0.2.0.

    • +

  • group (long) – The group ID. This attribute was added in vSphere API 7.0.2.0.

    • +

  • permissions (str) – The file permissions in chmod(2) format. This attribute is +presented as octal. This attribute was added in vSphere API +7.0.2.0.

    • +
+
+
+
+ +
+
+class PosixFileAttributesUpdateSpec(owner_id=None, group_id=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.PosixFileAttributesUpdateSpec class describes attributes that +can be changed for a Posix file. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • owner_id (long or None) – The owner ID. This attribute was added in vSphere API 7.0.2.0. +If None the value will not be changed.

    • +

  • group_id (long or None) – The group ID. This attribute was added in vSphere API 7.0.2.0. +If None the value will not be changed.

    • +

  • permissions (str or None) – The file permissions in chmod(2) format. This attribute is +interpreted as octal. This attribute was added in vSphere API +7.0.2.0. +If None the value will not be changed.

    • +
+
+
+
+ +
+
+class Summary(filename=None, type=None, size=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.Summary class describes a file or directory in the guest +operating system returned by a Files.list() method. This class was +added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • filename (str) – The name of the file or directory with any leading directories +removed. This attribute was added in vSphere API 7.0.2.0.

    • +

  • type (Files.Type) – The type of file. This attribute was added in vSphere API 7.0.2.0.

    • +

  • size (long) – The file size in bytes. This attribute was added in vSphere API +7.0.2.0.

    • +
+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Files.Type class defines the valid types of files. This enumeration +was added in vSphere API 7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+DIRECTORY = Type(string='DIRECTORY')
+

directory. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+FILE = Type(string='FILE')
+

normal file. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +

symbolic link. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+
+class WindowsFileAttributesInfo(hidden=None, read_only=None, created=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The {\@name WindowsFileAttributesInfo) class describes file attributes +specific to Windows Guest operating systems. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hidden (bool) – The file is hidden. This attribute was added in vSphere API +7.0.2.0.

    • +

  • read_only (bool) – The file is read-only. This attribute was added in vSphere API +7.0.2.0.

    • +

  • created (datetime.datetime) – The date and time the file was created. This attribute was added in +vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+class WindowsFileAttributesUpdateSpec(hidden=None, read_only=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Files.WindowsFileAttributesUpdateSpec class describes attributes +that can be changed for a Windows file. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hidden (bool or None) – The file is hidden. This attribute was added in vSphere API +7.0.2.0. +If {term unset} the value will not be changed.

    • +

  • read_only (bool or None) – The file is read-only. This attribute was added in vSphere API +7.0.2.0. +If {term unset} the value will not be changed.

    • +
+
+
+
+ +
+
+create_temporary(vm, credentials, prefix, suffix, parent_path=None)
+

Creates a temporary file.

+

Creates a new unique temporary file for the user to use as needed. The +user is responsible for removing it when it is no longer needed.

+

The new file name will be created in a guest-specific format using +prefix, a guest generated string and suffix in parent_path.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • prefix (str) – The prefix to be given to the new temporary file.

    • +

  • suffix (str) – The suffix to be given to the new temporary file.

    • +

  • parent_path (str or None) – The complete path to the directory in which to create the file. +Directory to use if specified, otherwise a guest-specific default +will be used.

    • +
+
+
Return type
+

str

+
+
Returns
+

The absolute path of the temporary file that is created.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if parent_path is set and is not a directory. The +value of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if parent_path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if parent_path is set and does not exist. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if parent_path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if a file cannot be created because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+
+delete(vm, credentials, path)
+

Deletes a file in the guest operating system

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the file or symbolic link to be deleted.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is not a file. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be deleted because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+
+get(vm, credentials, path)
+

Returns information about a file or directory in the guest.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the file.

    • +
+
+
Return type
+

Files.Info

+
+
Returns
+

Files.Info object containing information for the file.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be listed because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Query.

    • +
+
+
+
+ +
+
+list(vm, credentials, path, iteration=None, filter=None)
+

Returns information about files and directories in the guest.

+

Files are returned in operating system-specific (inode) order. If the +directory is modified between queries, missing or duplicate results can +occur.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the directory or file to query.

    • +

  • iteration (Files.IterationSpec or None) – The specification of a page of results to be retrieved. +If None, the first page will be retrieved.

    • +

  • filter (Files.FilterSpec or None) – Specification to match files for which information should be +returned. +If None, the behavior is the equivalent to a +Files.FilterSpec with all attributes None which means all +filenames match the filter.

    • +
+
+
Return type
+

Files.ListResult

+
+
Returns
+

A Files.ListResult object containing information for all +the matching files in filter and the total number of files that +can be returned.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If {\@param.iteration} contains invalid data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +If filter contains an invalid regular expression.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be listed because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Query.

    • +
+
+
+
+ +
+
+move(vm, credentials, path, new_path, overwrite=None)
+

Renames a file in the guest.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the original file or symbolic link to be +moved.

    • +

  • new_path (str) – The complete path to the new file. It cannot be a path to an +existing directory.

    • +

  • overwrite (bool or None) – If true, the destination file is overwritten. +If None, the destination file is not overwritten.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if the new_path already exists and overwrite is false.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is not a file. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if new_path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path does not exist. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the parent directory of new_path does not exist. The value +of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if a path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if a path cannot be renamed because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+
+update(vm, credentials, path, file_attributes)
+

Changes the file attributes of a specified file or directory inside the +guest.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication data.

    • +

  • path (str) – The complete path to the file or directory to be changed in the +guest. If the file points to an symbolic link, then the attributes +of the target file are changed.

    • +

  • file_attributes (Files.FileAttributesUpdateSpec) – Specifies the different file attributes of the guest file to be +changed. See Files.FileAttributesUpdateSpec.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if file_attributes does not apply to the guest operating +system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is not a file. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if path is too long. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if path is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if path cannot be updated because the guest authentication will +not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest.filesystem_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.vm.guest.filesystem_client.Transfers(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Transfers class provides methods to copy files into and out of the +guest file system. This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(path=None, attributes=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transfers.CreateSpec class describes the details of a file transfer +operation. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) – The complete destination path in the guest to transfer the file to +or from the client. It cannot be a path to a directory or a +symbolic link. This attribute was added in vSphere API 7.0.2.0.

    • +

  • attributes (Transfers.FileCreationAttributes or None) – Details about the file to be transferred into the guest. This +attribute was added in vSphere API 7.0.2.0. +Must be set if the file is being transferred to the guest. +Must not be set if the file is being transferred from the +guest.

    • +
+
+
+
+ +
+
+class FileCreationAttributes(size=None, overwrite=None, last_modified=None, last_accessed=None, windows=None, posix=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transfers.FileCreationAttributes class describes file attributes +used when transferring a file into the guest. This class was added in +vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size (long) – The size in bytes of the file to be transferred into the guest. +This attribute was added in vSphere API 7.0.2.0.

    • +

  • overwrite (bool or None) – Whether an existing file should be overwritten. This attribute was +added in vSphere API 7.0.2.0. +If None any existing file will not be overwritten.

    • +

  • last_modified (datetime.datetime or None) – The date and time the file was last modified. This attribute was +added in vSphere API 7.0.2.0. +If None the value will be the time when the file is transferred +into the guest.

    • +

  • last_accessed (datetime.datetime or None) – The date and time the file was last accessed. This attribute was +added in vSphere API 7.0.2.0. +If None the value will be the time when the file is transferred +into the guest.

    • +

  • windows (Transfers.WindowsFileAttributesCreateSpec or None) – Windows-specific file creation information. This attribute was +added in vSphere API 7.0.2.0. +If None, the behavior is equivalent to a +Transfers.WindowsFileAttributesCreateSpec with all +attributes None which means the defaults are used. May only be +set if the guest operating system is Windows.

    • +

  • posix (Transfers.PosixFileAttributesCreateSpec or None) – Posix-specific file creation information. This attribute was added +in vSphere API 7.0.2.0. +If None, the behavior is equivalent to a +Transfers.PosixFileAttributesCreateSpec with all +attributes None which means the defaults are used. May only be +set if the guest operating system is Posix.

    • +
+
+
+
+ +
+
+class PosixFileAttributesCreateSpec(owner_id=None, group_id=None, permissions=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transfers.PosixFileAttributesCreateSpec class describes creation +information about file attributes specific to Posix guest operating +systems. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • owner_id (long or None) – The owner ID. If this property is not specified when passing a +Transfers.PosixFileAttributesCreateSpec object to +Transfers.create(), the default value will be the owner Id of +the user who invoked the file transfer operation. This attribute +was added in vSphere API 7.0.2.0. +Defaults to uid of user invoking the operation.

    • +

  • group_id (long or None) – The group ID. If this property is not specified when passing a +Transfers.PosixFileAttributesCreateSpec object to +Transfers.create(), the default value will be the group Id of +the user who invoked the file transfer operation. This attribute +was added in vSphere API 7.0.2.0. +Defaults to gid of user invoking the operation.

    • +

  • permissions (str or None) – The file permissions in chmod(2) format. If this property is not +specified when passing a +Transfers.PosixFileAttributesCreateSpec object to +Transfers.create(), the file will be created with 0644 +permissions. This attribute is interpreted as octal. This attribute +was added in vSphere API 7.0.2.0. +Defaults to 0644.

    • +
+
+
+
+ +
+
+class WindowsFileAttributesCreateSpec(hidden=None, read_only=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Transfers.WindowsFileAttributesCreateSpec class describes creation +information about file attributes specific to Windows guest operating +systems. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • hidden (bool or None) – The file is hidden. This attribute was added in vSphere API +7.0.2.0. +If None the file will not be hidden.

    • +

  • read_only (bool or None) – The file is read-only. This attribute was added in vSphere API +7.0.2.0. +If None the file will be writeable.

    • +
+
+
+
+ +
+
+create(vm, credentials, spec)
+

Initiates an operation to transfer a file to or from the guest.

+

If the power state of the Virtual Machine is changed when the file +transfer is in progress, or the Virtual Machine is migrated, then the +transfer operation is aborted.

+

When transferring a file into the guest and overwriting an existing +file, the old file attributes are not preserved.

+

In order to ensure a secure connection to the host when transferring a +file using HTTPS, the X.509 certificate for the host must be used to +authenticate the remote end of the connection. The certificate of the +host that the virtual machine is running on can be retrieved using the +following fields: XXX insert link to certificate in Host config XXX

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual Machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (com.vmware.vcenter.vm.guest_client.Credentials) – The guest authentication credentials.

    • +

  • spec (Transfers.CreateSpec) – A specification of the type of file transfer and any applicable +attibutes.

    • +
+
+
Return type
+

str

+
+
Returns
+

The URL to which the user has to send an HTTP request. The URL will +become invalid once a successful request is sent. If the file is +being transferred from the guest, an HTTP GET should be used. If +the file is being transferred to the guest, HTTP PUT should be +used. +The URL is valid only for 10 minutes from the time it is generated. +The URL becomes invalid whenever the virtual machine is powered +off, suspended, unregistered or migrated to a new host. The host +part of the URL is returned as * if the hostname to be used is +the name of the server to which the call was made. For example, if +the call is made to esx-svr-1.domain1.com, and the file is +available for download from +https://esx-svr-1.domain1.com/guestFile?id=1&token=1234, the URL +returned may be {\@literal +aHR0cHM6Ly8mIzQyOy9ndWVzdEZpbGU/aWQ9MSZ0b2tlbj0xMjM0}. The client +replaces the asterisk with the server name on which it invoked the +call.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if Transfers.CreateSpec.path in spec exists and +Transfers.FileCreationAttributes.overwrite is false when +transferring a file to the guest.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if Transfers.CreateSpec.path in spec is not a file. The +value of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if Transfers.CreateSpec.path in spec is too long. The +value of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if Transfers.CreateSpec.path in spec is not found. The +value of com.vmware.vapi.std.errors_client.Error.data will +contain all the attributes defined in the FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if is insuffcient space for the new file when transferring a file +to the guest.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials object was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if Transfers.CreateSpec.path in spec cannot be +accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if Transfers.CreateSpec.path in spec cannot be copied +because the guest authentication will not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware Tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware Tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Modify.

    • +
+
+
+
+ +
+ +
+
+

com.vmware.vcenter.vm.guest.networking_client module

+

The com.vmware.vcenter.vm.guest.networking_client module provides classes +for dealing with the guest operating system networking.

+
+
+class com.vmware.vcenter.vm.guest.networking_client.Interfaces(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Interfaces class provides methods for retrieving guest operating +system network interface information. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(dns_values=None, mac_address=None, dns=None, ip=None, wins_servers=None, nic=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Interfaces.Info class describes a virtual network adapter +configured in the guest operating system. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dns_values (com.vmware.vcenter.vm.guest_client.DnsAssignedValues or None) – Client DNS values. Data assigned by DNS. This attribute was added +in vSphere API 7.0.0.0. +If None no DNS assigned value exists.

    • +

  • mac_address (str or None) – MAC address of the adapter. This attribute was added in vSphere API +7.0.0.0. +If None then not supported by the Guest OS.

    • +

  • dns (com.vmware.vcenter.vm.guest_client.DnsConfigInfo or None) – DNS configuration of the adapter. See +com.vmware.vcenter.vm.guest_client.Networking.Info.dns for +system wide settings. This attribute was added in vSphere API +7.0.0.0. +If None then not assigned by the Guest OS.

    • +

  • ip (Interfaces.IpConfigInfo or None) – IP configuration settings of the adapter. This attribute was added +in vSphere API 7.0.0.0. +If None then not supported by the Guest OS.

    • +

  • wins_servers (list of str or None) – The IP addresses of any WINS name servers for the adapter. This +attribute was added in vSphere API 7.0.0.0. +If None then not supported by the Guest OS.

    • +

  • nic (str or None) – Link to the corresponding virtual device. This attribute was added +in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet. +If None then the interface is not backed by a virtual device.

    • +
+
+
+
+ +
+
+class IpAddressInfo(ip_address=None, prefix_length=None, origin=None, state=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Interfaces.IpAddressInfo class describes a specific IP Address. +This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ip_address (str) – IPv4 address is specified using dotted decimal notation. For +example, “192.0.2.1”. IPv6 addresses are 128-bit addresses +specified using eight fields of up to four hexadecimal digits. A +colon separates each field (:). For example, +2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of +the symbol ‘::’ to represent multiple 16-bit groups of contiguous +0’s only once in an address as described in RFC 2373. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • prefix_length (long) – Denotes the length of a generic Internet network address prefix. +Prefix length: the valid range of values is 0-32 for IPv4, and +0-128 for IPv6. A value of n corresponds to an IP address mask that +has n contiguous 1-bits from the most significant bit (MSB), with +all other bits set to 0. A value of zero is valid only if the +calling context defines it. This attribute was added in vSphere API +7.0.0.0.

    • +

  • origin (Interfaces.IpAddressOrigin or None) – How this address was configured. This attribute was added in +vSphere API 7.0.0.0. +If None the data was not available.

    • +

  • state (Interfaces.IpAddressStatus) – The state of this ipAddress. This attribute was added in vSphere +API 7.0.0.0.

    • +
+
+
+
+ +
+
+class IpAddressOrigin(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Interfaces.IpAddressOrigin class specifies how an IP address was +obtained for an interface. See RFC 4293 IpAddressOriginTC. This enumeration +was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpAddressOrigin instance.

+
+
+
+
+DHCP = IpAddressOrigin(string='DHCP')
+

The address is configured through dhcp. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+LINKLAYER = IpAddressOrigin(string='LINKLAYER')
+

The address is obtained through stateless autoconfiguration (autoconf). See +RFC 4862, IPv6 Stateless Address Autoconfiguration. This class attribute +was added in vSphere API 7.0.0.0.

+
+ +
+
+MANUAL = IpAddressOrigin(string='MANUAL')
+

The address is configured manually. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+OTHER = IpAddressOrigin(string='OTHER')
+

Any other type of address configuration other than the below mentioned ones +will fall under this category. For e.g., automatic address configuration +for the link local address falls under this type. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+
+RANDOM = IpAddressOrigin(string='RANDOM')
+

The address is chosen by the system at random e.g., an IPv4 address within +169.254/16, or an RFC 3041 privacy address. This class attribute was added +in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class IpAddressStatus(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Interfaces.IpAddressStatus class defines the present status of an +address on an interface. See RFC 4293 IpAddressStatusTC. This enumeration +was added in vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the IpAddressStatus instance.

+
+
+
+
+DEPRECATED = IpAddressStatus(string='DEPRECATED')
+

Indicates that this is a valid but deprecated address that should no longer +be used as a source address. This class attribute was added in vSphere API +7.0.0.0.

+
+ +
+
+DUPLICATE = IpAddressStatus(string='DUPLICATE')
+

Indicates the address has been determined to be non-unique on the link, +this address will not be reachable. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+INACCESSIBLE = IpAddressStatus(string='INACCESSIBLE')
+

Indicates that the address is not accessible because interface is not +operational. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+INVALID = IpAddressStatus(string='INVALID')
+

Indicates that this isn’t a valid address. This class attribute was added +in vSphere API 7.0.0.0.

+
+ +
+
+PREFERRED = IpAddressStatus(string='PREFERRED')
+

Indicates that this is a valid address. This class attribute was added in +vSphere API 7.0.0.0.

+
+ +
+
+TENTATIVE = IpAddressStatus(string='TENTATIVE')
+

Indicates that the uniqueness of the address on the link is presently being +verified. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+UNKNOWN = IpAddressStatus(string='UNKNOWN')
+

Indicates that the status cannot be determined. This class attribute was +added in vSphere API 7.0.0.0.

+
+ +
+ +
+
+class IpConfigInfo(ip_addresses=None, dhcp=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Interfaces.IpConfigInfo class describes the protocol version +independent address reporting data object for network interfaces. This +class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
+
+
+
+ +
+
+list(vm)
+

Returns information about the networking interfaces in the guest +operating system. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

vm (str) – Virtual machine ID +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Interfaces.Info

+
+
Returns
+

Information about the interfaces configured in the guest operating +system. Interfaces are ordered in a guest operating system specific +determined order.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest.networking_client.Routes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Routes class provides methods for retrieving guest operating system +network routing information. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(network=None, prefix_length=None, gateway_address=None, interface_index=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Routes.Info class describes an individual host, network or default +destination network reachable through a gateway. This class was added in +vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • network (str) – IP Address of the destination IP network. IPv4 address is specified +using dotted decimal notation. For example, “192.0.2.1”. IPv6 +addresses are 128-bit specified using as eight fields of up to four +hexadecimal digits. A colon separates each field (:). For example, +2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of +symbol ‘::’ to represent multiple 16-bit groups of contiguous 0’s +only once in an address as described in RFC 2373. This attribute +was added in vSphere API 7.0.0.0.

    • +

  • prefix_length (long) – The prefix length. For IPv4 the value range is 0-32. For IPv6 +prefixLength is a decimal value range 0-128. The property +represents the number of contiguous, higher-order bits of the +address that make up the network portion of the IP address. This +attribute was added in vSphere API 7.0.0.0.

    • +

  • gateway_address (str or None) – Where to send the packets for this route. Unicast IP Address of the +next hop router. IPv4 address is specified using dotted decimal +notation. For example, “192.0.2.1”. IPv6 addresses are 128-bit +specified using as eight fields of up to four hexadecimal digits. A +colon separates each field (:). For example, +2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of +symbol ‘::’ to represent multiple 16-bit groups of contiguous 0’s +only once in an address as described in RFC 2373. This attribute +was added in vSphere API 7.0.0.0. +If None no gateway is set for the route.

    • +

  • interface_index (long or None) – The network interface associated with this route. This is an index +into the result of Interfaces.list() The index refers to the +relative position of an element in a list. For example, an +index of 0 refers to the first element in the list while +an index of 1 refers to the second element. This attribute was +added in vSphere API 7.0.0.0. +If None the route is not associated with a network interface.

    • +
+
+
+
+ +
+
+list(vm)
+

Returns information about network routing in the guest operating +system. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

vm (str) – Virtual machine ID +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Routes.Info

+
+
Returns
+

Information about the network routes configured in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest.networking_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.vm.hardware.html b/vsphere/8.0.2.0/com.vmware.vcenter.vm.hardware.html new file mode 100644 index 00000000..8893e21f --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.vm.hardware.html @@ -0,0 +1,1584 @@ + + + + + + + com.vmware.vcenter.vm.hardware package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.vm.hardware package

+
+

Submodules

+
+
+

com.vmware.vcenter.vm.hardware.adapter_client module

+

The com.vmware.vcenter.vm.hardware.adapter_client module provides classes +for managing the configuration and state of the virtual adapters belonging to a +virtual machine. This includes methods for reading and manipulating the +conifguration of USB adapters and host bus adapters.

+

Note that classes for adapters with no configurable properties or runtime +state, such as IDE and PCI adapters, are omitted.

+
+
+class com.vmware.vcenter.vm.hardware.adapter_client.Nvme(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Nvme class provides methods for configuring the virtual NVMe +adapters of a virtual machine. This class was added in vSphere API 7.0.0.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(bus=None, pci_slot_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Nvme.CreateSpec class provides a specification for the +configuration of a newly-created virtual NVMe adapter. This class was added +in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long or None) – NVMe bus number. This attribute was added in vSphere API 7.0.0.1. +If None, the server will choose an available bus number; if none is +available, the request will fail.

    • +

  • pci_slot_number (long or None) – Address of the NVMe adapter on the PCI bus. This attribute was +added in vSphere API 7.0.0.1. +If None, the server will choose an available address when the +virtual machine is powered on.

    • +
+
+
+
+ +
+
+class Info(label=None, bus=None, pci_slot_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Nvme.Info class contains information about a virtual NVMe adapter. +This class was added in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label. This attribute was added in vSphere API 7.0.0.1.

    • +

  • bus (long) – NVMe bus number. This attribute was added in vSphere API 7.0.0.1.

    • +

  • pci_slot_number (long or None) – Address of the NVMe adapter on the PCI bus. This attribute was +added in vSphere API 7.0.0.1. +May be None if the virtual machine has never been powered on since +the adapter was created.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.NvmeAdapter'
+

Resource type for the virtual NVMe adapter device. This class attribute was +added in vSphere API 7.0.0.1.

+
+ +
+
+class Summary(adapter=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Nvme.Summary class contains commonly used information about a +Virtual NVMe adapter. This class was added in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

adapter (str) – Identifier of the virtual NVMe adapter. This attribute was added in +vSphere API 7.0.0.1. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.NvmeAdapter. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.NvmeAdapter.

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual NVMe adapter to the virtual machine. This method was +added in vSphere API 7.0.0.1.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Nvme.CreateSpec) – Specification for the new virtual NVMe adapter.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual NVMe adapter identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.NvmeAdapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the NVMe adapter was created but was +unable to confirm the creation because the identifier of the new +adapter could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if there are no more available NVMe buses on the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the specified NVMe bus or PCI address is in use.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified NVMe bus or PCI address is out of bounds.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the guest operating system of the virtual machine is not +supported and spec includes None attributes that default to +guest-specific values.

+
+
+
+ +
+
+delete(vm, adapter)
+

Removes a virtual NVMe adapter from the virtual machine. This method +was added in vSphere API 7.0.0.1.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual NVMe adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.NvmeAdapter.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual NVMe adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, adapter)
+

Returns information about a virtual NVMe adapter. This method was added +in vSphere API 7.0.0.1.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual NVMe adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.NvmeAdapter.

    • +
+
+
Return type
+

Nvme.Info

+
+
Returns
+

Information about the specified virtual NVMe adapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual NVMe adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual NVMe adapters +belonging to the virtual machine. This method was added in vSphere API +7.0.0.1.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Nvme.Summary

+
+
Returns
+

List of commonly used information about virtual NVMe adapters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware.adapter_client.Sata(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Sata class provides methods for configuring the virtual SATA +adapters of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(type=None, bus=None, pci_slot_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Sata.CreateSpec class provides a specification for the +configuration of a newly-created virtual SATA adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Sata.Type or None) – Adapter type. +If None, a guest-specific default value will be used.

    • +

  • bus (long or None) – SATA bus number. +If None, the server will choose an available bus number; if none is +available, the request will fail.

    • +

  • pci_slot_number (long or None) – Address of the SATA adapter on the PCI bus. +If None, the server will choose an available address when the +virtual machine is powered on.

    • +
+
+
+
+ +
+
+class Info(label=None, type=None, bus=None, pci_slot_number=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Sata.Info class contains information about a virtual SATA adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • type (Sata.Type) – Adapter type.

    • +

  • bus (long) – SATA bus number.

    • +

  • pci_slot_number (long or None) – Address of the SATA adapter on the PCI bus. +May be None if the virtual machine has never been powered on since +the adapter was created.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.SataAdapter'
+

Resource type for the virtual SATA adapter device.

+
+ +
+
+class Summary(adapter=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Sata.Summary class contains commonly used information about a +Virtual SATA adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

adapter (str) – Identifier of the virtual SATA adapter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SataAdapter. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.SataAdapter.

+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Sata.Type class defines the valid emulation types for a virtual +SATA adapter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+AHCI = Type(string='AHCI')
+

AHCI host bus adapter.

+
+ +
+ +
+
+create(vm, spec)
+

Adds a virtual SATA adapter to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Sata.CreateSpec) – Specification for the new virtual SATA adapter.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual SATA adapter identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SataAdapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the SATA adapter was created but was +unable to confirm the creation because the identifier of the new +adapter could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if there are no more available SATA buses on the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the specified SATA bus or PCI address is in use.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified SATA bus or PCI address is out of bounds.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the guest operating system of the virtual machine is not +supported and spec includes None attributes that default to +guest-specific values.

+
+
+
+ +
+
+delete(vm, adapter)
+

Removes a virtual SATA adapter from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual SATA adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SataAdapter.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual SATA adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, adapter)
+

Returns information about a virtual SATA adapter.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual SATA adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SataAdapter.

    • +
+
+
Return type
+

Sata.Info

+
+
Returns
+

Information about the specified virtual SATA adapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual SATA adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual SATA adapters +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Sata.Summary

+
+
Returns
+

List of commonly used information about virtual SATA adapters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware.adapter_client.Scsi(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Scsi class provides methods for configuring the virtual SCSI +adapters of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(type=None, bus=None, pci_slot_number=None, sharing=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Scsi.CreateSpec class provides a specification for the +configuration of a newly-created virtual SCSI adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Scsi.Type or None) – Adapter type. +If None, a guest-specific default value will be used.

    • +

  • bus (long or None) – SCSI bus number. +If None, the server will choose an available bus number; if none is +available, the request will fail.

    • +

  • pci_slot_number (long or None) – Address of the SCSI adapter on the PCI bus. If the PCI address is +invalid, the server will change it when the VM is started or as the +device is hot added. +If None, the server will choose an available address when the +virtual machine is powered on.

    • +

  • sharing (Scsi.Sharing or None) – Bus sharing mode. +If None, the adapter will default to Scsi.Sharing.NONE.

    • +
+
+
+
+ +
+
+class Info(label=None, type=None, scsi=None, pci_slot_number=None, sharing=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Scsi.Info class contains information about a virtual SCSI adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • type (Scsi.Type) – Adapter type.

    • +

  • scsi (com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo) – Address of the SCSI adapter on the SCSI bus.

    • +

  • pci_slot_number (long or None) – Address of the SCSI adapter on the PCI bus. If the PCI address is +invalid, the server will change it when the VM is started or as the +device is hot added. +May be None if the virtual machine has never been powered on since +the adapter was created.

    • +

  • sharing (Scsi.Sharing) – Bus sharing mode.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.ScsiAdapter'
+

Resource type for the virtual SCSI adapter device.

+
+ +
+
+class Sharing(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Scsi.Sharing class defines the valid bus sharing modes for a +virtual SCSI adapter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Sharing instance.

+
+
+
+
+NONE = Sharing(string='NONE')
+

The virtual SCSI bus is not shared.

+
+ +
+
+PHYSICAL = Sharing(string='PHYSICAL')
+

The virtual SCSI bus is shared between two or more virtual machines +residing on different physical hosts.

+
+ +
+
+VIRTUAL = Sharing(string='VIRTUAL')
+

The virtual SCSI bus is shared between two or more virtual machines. In +this case, no physical machine is involved.

+
+ +
+ +
+
+class Summary(adapter=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Scsi.Summary class contains commonly used information about a +Virtual SCSI adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

adapter (str) – Identifier of the virtual SCSI adapter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ScsiAdapter. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.ScsiAdapter.

+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Scsi.Type class defines the valid emulation types for a virtual +SCSI adapter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+BUSLOGIC = Type(string='BUSLOGIC')
+

BusLogic host bus adapter.

+
+ +
+
+LSILOGIC = Type(string='LSILOGIC')
+

LSI Logic host bus adapter.

+
+ +
+
+LSILOGICSAS = Type(string='LSILOGICSAS')
+

LSI Logic SAS 1068 host bus adapter.

+
+ +
+
+PVSCSI = Type(string='PVSCSI')
+

Paravirtualized host bus adapter.

+
+ +
+ +
+
+class UpdateSpec(sharing=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Scsi.UpdateSpec class describes the updates to be made to the +configuration of a virtual SCSI adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

sharing (Scsi.Sharing or None) –

Bus sharing mode.

+

This attribute may only be modified if the virtual machine is not +powered on. +If None, the value is unchanged.

+

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual SCSI adapter to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Scsi.CreateSpec) – Specification for the new virtual SCSI adapter.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual SCSI adapter identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ScsiAdapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the SCSI adapter was created but was +unable to confirm the creation because the identifier of the new +adapter could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if there are no more available SCSI buses on the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the specified SCSI bus is in use.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified SATA bus or PCI address is out of bounds.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the guest operating system of the virtual machine is not +supported and spec includes None attributes that default to +guest-specific values.

+
+
+
+ +
+
+delete(vm, adapter)
+

Removes a virtual SCSI adapter from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual SCSI adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ScsiAdapter.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual SCSI adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, adapter)
+

Returns information about a virtual SCSI adapter.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual SCSI adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ScsiAdapter.

    • +
+
+
Return type
+

Scsi.Info

+
+
Returns
+

Information about the specified virtual SCSI adapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual SCSI adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual SCSI adapters +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Scsi.Summary

+
+
Returns
+

List of commonly used information about virtual SCSI adapters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, adapter, spec)
+

Updates the configuration of a virtual SCSI adapter.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • adapter (str) – Virtual SCSI adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ScsiAdapter.

    • +

  • spec (Scsi.UpdateSpec) – Specification for updating the virtual SCSI adapter.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual SCSI adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if one or more of the attributes specified in the spec +parameter cannot be modified due to the current power state of the +virtual machine or the connection state of the virtual SCSI +adapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware.adapter_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm.hardware.boot_client module

+

The com.vmware.vcenter.vm.hardware.boot_client module provides classes for +managing the virtual devices used to boot a virtual machine.

+
+
+class com.vmware.vcenter.vm.hardware.boot_client.Device(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Device class provides methods for configuring the device order used +when booting a virtual machine.

+

The boot order may be specified using a mixture of device classes and +device instances, chosen from among the following:

+
    +

  • Device.Type.CDROM: Boot from a virtual CD-ROM drive; the device +instance(s) will be chosen by the BIOS subsystem.

    • +

  • Device.Type.FLOPPY: Boot from a virtual floppy drive; the device +instance(s) will be chosen by the BIOS subsystem.

    • +

  • Device.Type.DISK: Boot from a virtual disk device; the device +instance is specified explicitly in Device.Entry.disks list, and +multiple instances may be specified in the list.

    • +

  • Device.Type.ETHERNET: Boot from a virtual Ethernet adapter; the +device instance is specified explicitly as Device.Entry.nic, and +multiple adapters may be specified in the boot order list.

    • +
+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Entry(type=None, nic=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Device.Entry class specifies a bootable virtual device class or +specific bootable virtual device(s).

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Device.Type) – Virtual device type.

    • +

  • nic (str) – Virtual Ethernet device. Ethernet device to use as boot device for +this entry. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet. +This attribute is optional and it is only relevant when the value +of type is Device.Type.ETHERNET.

    • +

  • disks (list of str) – Virtual disk device. List of virtual disks in boot order. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +This attribute is optional and it is only relevant when the value +of type is Device.Type.DISK.

    • +
+
+
+
+ +
+
+class EntryCreateSpec(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The class Device.EntryCreateSpec specifies a list of bootable virtual +device classes. When a VM is being created and a list of +Device.EntryCreateSpec is specified, the boot order of the specific +device instances are not specified in this class. The boot order of the +specific device instance will be the order in which the Ethernet and Disk +devices appear in the nics and disks respectively.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (Device.Type) – Virtual Boot device type.

+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Device.Type class defines the valid device types that may be used +as bootable devices.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+CDROM = Type(string='CDROM')
+

Virtual CD-ROM device.

+
+ +
+
+DISK = Type(string='DISK')
+

Virtual disk device.

+
+ +
+
+ETHERNET = Type(string='ETHERNET')
+

Virtual Ethernet adapter.

+
+ +
+
+FLOPPY = Type(string='FLOPPY')
+

Virtual floppy drive.

+
+ +
+ +
+
+get(vm)
+

Returns an ordered list of boot devices for the virtual machine. If the +list is empty, the virtual machine uses a default boot +sequence.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Device.Entry

+
+
Returns
+

Ordered list of configured boot devices.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+set(vm, devices)
+

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 +list is empty, the virtual machine will use a default boot +sequence. There should be no more than one instance of +Device.Entry for a given device type except +Device.Type.ETHERNET in the list.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • devices (list of Device.Entry) – Ordered list of boot devices.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found, or if any of the specified +virtual devices is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in +more than one Device.Entry with the exception of +Device.Type.ETHERNET, which may appear multiple times if +the virtual machine has been configured with multiple Ethernet +adapters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware.boot_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.vm.html b/vsphere/8.0.2.0/com.vmware.vcenter.vm.html new file mode 100644 index 00000000..ab01beca --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.vm.html @@ -0,0 +1,8079 @@ + + + + + + + com.vmware.vcenter.vm package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.vm package

+
+

Subpackages

+
+ +
+
+
+

Submodules

+
+
+

com.vmware.vcenter.vm.compute_client module

+

The com.vmware.vcenter.vm.compute_client module provides classes for +quering the status of compute policies on virtual machines.

+
+
+class com.vmware.vcenter.vm.compute_client.Policies(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Policies class provides methods to query the status of policies on +virtual machines.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(status=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policies.Info class contains information about the compliance of a +virtual machine with a compute policy.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

status (com.vmware.vcenter.compute.policies_client.ObjectCompliance) – The compliance status of the policy on a specified object.

+
+
+
+ +
+
+get(vm, policy)
+

Returns information about the compliance of a virtual machine with a +compute policy.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine to query the status for. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • policy (str) – Identifier of the policy to query the status for. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.compute.Resources.COMPUTE_POLICY.

    • +
+
+
Return type
+

Policies.Info

+
+
Returns
+

Information about the compliance of the specified virtual machine +with the specified compute policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a virtual machine with the given identifier does not exist, or +if a policy with the given identifier does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.compute_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm.console_client module

+

The com.vmware.vcenter.vm.console_client module provides classes for +managing Virtual Machine Consoles.

+
+
+class com.vmware.vcenter.vm.console_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.vm.console_client.Tickets(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Tickets class provides methods for managing the virtual machine +console tickets. This class was added in vSphere API 7.0.0.2.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tickets.CreateSpec class defines the information used to create the +virtual machine console ticket. This class was added in vSphere API +7.0.0.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

type (Tickets.Type) – The type of virtual machine console ticket. This attribute was +added in vSphere API 7.0.0.2.

+
+
+
+ +
+
+class Summary(ticket=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Tickets.Summary class contains commonly used information about the +virtual machine console ticket. This class was added in vSphere API +7.0.0.2.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

ticket (str) – Console ticket URI. This attribute was added in vSphere API +7.0.0.2.

+
+
+
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Tickets.Type class defines the types of console tickets. This +enumeration was added in vSphere API 7.0.0.2.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+VMRC = Type(string='VMRC')
+

Virtual machine remote console ticket. This class attribute was added in +vSphere API 7.0.0.2.

+
+ +
+
+WEBMKS = Type(string='WEBMKS')
+

Web socket console ticket. This class attribute was added in vSphere API +7.0.0.2.

+
+ +
+ +
+
+create(vm, spec)
+

Creates a virtual machine console ticket of a given ticket type. The +created ticket is a one time use URI. The validity of the ticket is 30 +minutes, if not used with in the time frame the ticket expires.

+

The Tickets.Type.VMRC ticket contains the IP address or the DNS +resolvable name of the vCenter server. This ticket requires +installation of VMware Workstation, VMware Fusion or VMRC to be +installed on the machine where the ticket has to be opened. This ticket +can be acquired even when the VM is turned off.

+

The Tickets.Type.WEBMKS ticket contains the IP address of the +DNS resolvable name of the ESX server. This ticket requires user to +embed this ticket in a HTML page using VMware HTML Console SDK - +https://www.vmware.com/support/developer/html-console This ticket can +be acquired only when the VM is turned on.. This method was added in +vSphere API 7.0.0.2.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Tickets.CreateSpec) – Specification for the console ticket to be created.

    • +
+
+
Return type
+

Tickets.Summary

+
+
Returns
+

Commonly used information about the virtual machine console ticket.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the {\@link CreateSpec#type) attribute contains a value that +is not supported by the server.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is powered off and requested ticket type is +Tickets.Type.WEBMKS

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration or execution state cannot be +accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+

com.vmware.vcenter.vm.data_sets_client module

+

The com.vmware.vcenter.vm.data_sets_client module provides classes for +manipulating entries in data sets.

+
+
+class com.vmware.vcenter.vm.data_sets_client.Entries(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Entries class provides methods for manipulating individual entries +in a data set. This class was added in vSphere API 8.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+delete(vm, data_set, key)
+

Deletes an entry in a data set. This method was added in vSphere API +8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +

  • key (str) – The key of the entry to delete. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.data_sets.Entry.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is in a state that doesn’t allow +modifications, for example suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no entry associated with key in the data_set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the data set access mode prevents the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetEntryDelete.

    • +
+
+
+
+ +
+
+get(vm, data_set, key)
+

Retrieves the value of an entry in a data set. This method was added in +vSphere API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +

  • key (str) – The key of the entry to retrieve. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.data_sets.Entry.

    • +
+
+
Return type
+

str

+
+
Returns
+

the value of the entry.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if there is no entry associated with key in the data_set.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the data set access mode prevents the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetEntryGet.

    • +
+
+
+
+ +
+
+list(vm, data_set)
+

Lists all entry keys in a data set. This method was added in vSphere +API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +
+
+
Return type
+

set of str

+
+
Returns
+

The keys belonging to the data set. +The return value will contain identifiers for the resource type: +com.vmware.vcenter.vm.data_sets.Entry.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the data set access mode prevents the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetEntryList.

    • +
+
+
+
+ +
+
+set(vm, data_set, key, value)
+

Creates or updates an entry in a data set. If an entry whose key +matches key already exists, it will replace the existing value, +otherwise it will create a new entry. This method was added in vSphere +API 8.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • data_set (str) – Identifier of the data set. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.DataSet.

    • +

  • key (str) – The key of the entry to set. A key can be at most 4096 bytes. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.data_sets.Entry.

    • +

  • value (str) – The value of the entry to set. A value can be at most 1MB.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the key is too large.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the value is too large.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is in a state that doesn’t allow +modifications, for example suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the data set is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the new data set requires more resources than are available.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the data set access mode prevents the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual hardware version of the virtual machine does not +support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the ESXi host version does not support DataSets

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.DataSets.DataSetEntrySet.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.data_sets_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm.guest_client module

+

The com.vmware.vcenter.vm.guest_client module provides classes for dealing +with the guest operating system. This includes information about the state of +local file systems and network interfaces and methods to manipulate the guest +file system and processes.

+
+
+class com.vmware.vcenter.vm.guest_client.Credentials(interactive_session=None, type=None, user_name=None, password=None, saml_token=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Credentials class defines the guest credentials used for guest +operation authentication. This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • interactive_session (bool) – If set, the method will interact with the logged-in +desktop session in the guest. This requires that the logged-on user +matches the user specified by the Credentials. This is +currently only supported for +Credentials.Type.USERNAME_PASSWORD. This attribute was +added in vSphere API 7.0.2.0.

    • +

  • type (Credentials.Type) – The guest credentials type. This attribute was added in vSphere API +7.0.2.0.

    • +

  • user_name (str or None) – For Credentials.Type.SAML_BEARER_TOKEN, this is the guest +user to be associated with the credentials. For +Credentials.Type.USERNAME_PASSWORD this is the guest +username. This attribute was added in vSphere API 7.0.2.0. +If no user is specified for +Credentials.Type.SAML_BEARER_TOKEN, a guest dependent +mapping will decide what guest user account is applied.

    • +

  • password (str) – password. This attribute was added in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of type is Credentials.Type.USERNAME_PASSWORD.

    • +

  • saml_token (str) – SAML Bearer Token. This attribute was added in vSphere API 7.0.2.0. +This attribute is optional and it is only relevant when the value +of type is Credentials.Type.SAML_BEARER_TOKEN.

    • +
+
+
+
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Types of guest credentials. This enumeration was added in vSphere API +7.0.2.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+SAML_BEARER_TOKEN = Type(string='SAML_BEARER_TOKEN')
+

SAML_BEARER_TOKEN contains the information necessary to authenticate within +a guest using a SAML token. SAML Bearer token credentials relies on a guest +alias that associates a guest account with the subject and certificate +encoded in a SAML Bearer token obtained from the VMware SSO Server. This +class attribute was added in vSphere API 7.0.2.0.

+
+ +
+
+USERNAME_PASSWORD = Type(string='USERNAME_PASSWORD')
+

USERNAME_PASSWORD credentials contains the information necessary to +authenticate within a guest using a username and password. This method of +authentication is stateless.

+

To use USERNAME_PASSWORD, populate userName and password with the +appropriate login information.

+

Once populated, you can use USERNAME_PASSWORD in any guest operations +method.. This class attribute was added in vSphere API 7.0.2.0.

+
+ +
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.Customization(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Customization class provides methods to apply a customization +specification to a virtual machine in powered-off status. This class was +added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(status=None, error=None, start_time=None, end_time=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Customization.Info class contains the status of a customization +operation applied to a virtual machine. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Customization.Info.Status) – The status of the customization operation. This attribute was added +in vSphere API 7.0.0.0.

    • +

  • error (str or None) – Description of the error if the Customization.Info.status +of customization operation is +Customization.Info.Status.FAILED. This attribute was added +in vSphere API 7.0.0.0. +This attribute will be None if the status is not FAILED or there is +no information available for the error.

    • +

  • start_time (datetime.datetime or None) – Time when the customization process has started inside the guest +operating system. This attribute was added in vSphere API 7.0.0.0. +This attribute will be None if the status is PENDING.

    • +

  • end_time (datetime.datetime or None) – Time when the customization process has completed inside the guest +operating system. This attribute was added in vSphere API 7.0.0.0. +This attribute will be None if the status is not SUCCEEDED or +FAILED.

    • +
+
+
+
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Customization.Info.Status class defines the status values that can +be reported for the customization operation. This enumeration was added in +vSphere API 7.0.0.0.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+FAILED = Status(string='FAILED')
+

The customizatio process has failed inside the guest operating system. This +class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+IDLE = Status(string='IDLE')
+

No customization spec is applied to the guest operating system. This class +attribute was added in vSphere API 7.0.3.0.

+
+ +
+
+PENDING = Status(string='PENDING')
+

The customization process has not yet started inside the guest operating +system. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+RUNNING = Status(string='RUNNING')
+

The customization process is currently running inside the guest operating +system. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+
+SUCCEEDED = Status(string='SUCCEEDED')
+

The customization process has completed successfully inside the guest +operating system. This class attribute was added in vSphere API 7.0.0.0.

+
+ +
+ +
+ +
+
+class SetSpec(name=None, spec=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Customization.SetSpec class contains specification information that +has to be applied to a virtual machine. This class was added in vSphere API +7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – The name of the customization specification that has be retrieved +from the virtual center inventory and applied for the virtual +machine. Either one of name or spec or none of them should +be specified. This attribute was added in vSphere API 7.0.0.0. +If None and spec is also None when executing +Customization.set() method, then any pending customization +for the virtual machine will be cleared.

    • +

  • spec (com.vmware.vcenter.guest_client.CustomizationSpec or None) – The customization specification that has to be applied for the +virtual machine. Either one of name or spec or none of them +should be specified. This attribute was added in vSphere API +7.0.0.0. +If None and name is also None when executing +Customization.set() method, then any pending customization +for the virtual machine will be cleared.

    • +
+
+
+
+ +
+
+get(vm)
+

Returns the status of the customization operation that has been applied +for the virtual machine in vm. This method was added in vSphere API +7.0.3.0.

+
+
Parameters
+

vm (str) – The unique identifier of the virtual machine that needs to be +queried. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Customization.Info

+
+
Returns
+

The status of the customization operation applied for the virtual +machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires System.View.

    • +
+
+
+
+ +
+
+set(vm, spec)
+

Applies a customization specification in spec on the virtual +machine in vm. This method only sets the specification settings for +the virtual machine. The actual customization happens inside the guest +when the virtual machine is powered on. If spec has None values, +then any pending customization settings for the virtual machine are +cleared. If there is a pending customization for the virtual machine +and spec has valid content, then the existing customization setting +will be overwritten with the new settings. This method was added in +vSphere API 7.0.0.0.

+
+
Parameters
+
    +

  • vm (str) – The unique identifier of the virtual machine that needs to be +customized. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Customization.SetSpec) – The customization settings to be applied to the guest operating +system.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the customization settings in spec are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not in a powered off state.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if a customization specification is not found with the unique name +in spec.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +If the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Provisioning.Customize.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.DhcpConfigInfo(ipv4_enabled=None, ipv6_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DhcpConfigInfo class specifies when Dynamic Host Configuration +Protocol is enabled. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ipv4_enabled (bool) – True if IPv4 DHCP is enabled, false otherwise. This attribute was +added in vSphere API 7.0.0.0.

    • +

  • ipv6_enabled (bool) – True if IPv6 DHCP is enabled, false otherwise. This attribute was +added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.guest_client.DnsAssignedValues(host_name=None, domain_name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The {\@name DnsAssignedValues) class describes values assigned by a +Domain Name Server (DNS). This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • host_name (str) – The host name portion of DNS name. For example, “esx01” part of +esx01.example.com. This attribute was added in vSphere API 7.0.0.0.

    • +

  • domain_name (str) – The domain name portion of the DNS name. “example.com” part of +esx01.example.com. This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.guest_client.DnsConfigInfo(ip_addresses=None, search_domains=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The DnsConfigInfo class describes the configuration of RFC 1034 DNS +settings. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • ip_addresses (list of str) – The IP addresses of the DNS servers in order of use. IPv4 addresses +are specified using dotted decimal notation. For example, +“192.0.2.1”. IPv6 addresses are 128-bit addresses represented as +eight fields of up to four hexadecimal digits. A colon separates +each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The +address can also consist of the symbol ‘::’ to represent multiple +16-bit groups of contiguous 0’s only once in an address as +described in RFC 2373. This attribute was added in vSphere API +7.0.0.0.

    • +

  • search_domains (list of str) – The domain in which to search for hosts, placed in order of +preference. These are the domain name portion of the DNS names. +This attribute was added in vSphere API 7.0.0.0.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.guest_client.Environment(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Environment class provides methods to manage environment variables +in the guest operating system. This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+get(vm, credentials, name)
+

Reads a single environment variable from the guest operating system.

+

If the authentication uses Credentials.interactive_session, +then the environment being read will be that of the user logged into +the desktop. Otherwise it’s the environment of the system user.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (Credentials) – The guest authentication data. See Credentials.

    • +

  • name (str) – The name of the environment variable to be read.

    • +
+
+
Return type
+

str

+
+
Returns
+

The value of the name environment variable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the environment variable name is not not set in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Query.

    • +
+
+
+
+ +
+
+list(vm, credentials, names)
+

Reads a list of environment variables from the guest operating system.

+

If the authentication uses Credentials.interactive_session, +then the environment being read will be that of the user logged into +the desktop. Otherwise it’s the environment of the system user.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (Credentials) – The guest authentication data. See Credentials.

    • +

  • names (set of str) – The names of the variables to be read. If the set is +empty, then all the environment variables are returned.

    • +
+
+
Return type
+

dict of str and str

+
+
Returns
+

Mapping from environment variable names to environment variable +values, or all environment variables if nothing is specified. If +any specified environment variable contained in names is not +set, then nothing is returned for that variable.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials are not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Query.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.Identity(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Identity class provides methods for retrieving guest operating +system identification information. This class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(name=None, family=None, full_name=None, host_name=None, ip_address=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Identity.Info class contains information describing the guest +operating system identification. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (com.vmware.vcenter.vm_client.GuestOS) – Guest operating system identifier (short name). This attribute was +added in vSphere API 6.7.

    • +

  • family (com.vmware.vcenter.vm_client.GuestOSFamily) – Guest operating system family. This attribute was added in vSphere +API 6.7.

    • +

  • full_name (com.vmware.vapi.std_client.LocalizableMessage) – Guest operating system full name. This attribute was added in +vSphere API 6.7.

    • +

  • host_name (str) – Hostname of the guest operating system. This attribute was added in +vSphere API 6.7.

    • +

  • ip_address (str or None) – IP address assigned by the guest operating system. This attribute +was added in vSphere API 6.7. +If None the guest does not have an IP address.

    • +
+
+
+
+ +
+
+get(vm)
+

Return information about the guest. This method was added in vSphere +API 6.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Identity.Info

+
+
Returns
+

guest identification information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools has not provided any data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.LocalFilesystem(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The LocalFilesystem class provides methods for retrieving information +about the guest operating system local file systems. This class was added +in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(capacity=None, free_space=None, filesystem=None, mappings=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The LocalFilesystem.Info class contains information about a local file +system configured in the guest operating system. This class was added in +vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • capacity (long) – Total capacity of the file system, in bytes. This attribute was +added in vSphere API 6.7.

    • +

  • free_space (long) – Free space on the file system, in bytes. This attribute was added +in vSphere API 6.7.

    • +

  • filesystem (str or None) – Filesystem type, if known. For example, ext3 or NTFS. This +attribute was added in vSphere API 7.0.0.0. +set if VMware Tools reports a value.

    • +

  • mappings (list of LocalFilesystem.VirtualDiskMapping) – VirtualDisks backing the guest partition, if known. This attribute +was added in vSphere API 7.0.0.0. +This attribute is optional because it was added in a newer version +than its parent node.

    • +
+
+
+
+ +
+
+class VirtualDiskMapping(disk=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Describes the virtual disk backing a local guest disk. This class was added +in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

disk (str) – The virtual disk. This attribute was added in vSphere API 7.0.0.0. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

+
+
+
+ +
+
+get(vm)
+

Returns details of the local file systems in the guest operating +system. This method was added in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

dict of str and LocalFilesystem.Info

+
+
Returns
+

Information about the local file systems configured in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools has not provided any data.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.Networking(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Networking class provides methods for retrieving guest operating +system network information. This class was added in vSphere API 7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(dns_values=None, dns=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Networking.Info class contains information about networking as +configured in the guest operating system. This class was added in vSphere +API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • dns_values (DnsAssignedValues or None) – Client DNS values. Data assigned by DNS. This attribute was added +in vSphere API 7.0.0.0. +If None no DNS assigned value exists.

    • +

  • dns (DnsConfigInfo or None) – Client DNS configuration. How DNS queries are resolved. This +attribute was added in vSphere API 7.0.0.0. +If None no DNS assigned value exists.

    • +
+
+
+
+ +
+
+get(vm)
+

Returns information about the network configuration in the guest +operating system. This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

vm (str) – Virtual machine ID +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Networking.Info

+
+
Returns
+

Information about the networking configuration in the guest +operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.Operations(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

Status of operations in the guest OS. This class was added in vSphere API +7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(guest_operations_ready=None, interactive_guest_operations_ready=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Guest operating system operation status information. This class was added +in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • guest_operations_ready (bool) – Guest operations availability. Whether or not the virtual machine +is ready to process guest operations. This attribute was added in +vSphere API 7.0.2.0.

    • +

  • interactive_guest_operations_ready (bool) – Interactive guest operations availability. Whether or not the +virtual machine is ready to process interactive guest operations. +This attribute was added in vSphere API 7.0.2.0.

    • +
+
+
+
+ +
+
+get(vm)
+

Get information about the guest operation status. This method was added +in vSphere API 7.0.2.0.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Operations.Info

+
+
Returns
+

guest operations readiness.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the state of VMware Tools is unknown.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.Power(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Power class provides methods for managing the guest operating +system power state of a virtual machine. This class was added in vSphere +API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(state=None, operations_ready=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

Information about the guest operating system power state. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (Power.State) – The power state of the guest operating system. This attribute was +added in vSphere API 6.7.

    • +

  • operations_ready (bool) – Flag indicating if the virtual machine is ready to process soft +power operations. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+class State(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

Possible guest power states. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the State instance.

+
+
+
+
+NOT_RUNNING = State(string='NOT_RUNNING')
+

The guest OS is not running. This class attribute was added in vSphere API +6.7.

+
+ +
+
+RESETTING = State(string='RESETTING')
+

The guest OS is resetting. This class attribute was added in vSphere API +6.7.

+
+ +
+
+RUNNING = State(string='RUNNING')
+

The guest OS is running. This class attribute was added in vSphere API 6.7.

+
+ +
+
+SHUTTING_DOWN = State(string='SHUTTING_DOWN')
+

The guest OS is shutting down. This class attribute was added in vSphere +API 6.7.

+
+ +
+
+STANDBY = State(string='STANDBY')
+

The guest OS is in standby. This class attribute was added in vSphere API +6.7.

+
+ +
+
+UNAVAILABLE = State(string='UNAVAILABLE')
+

The guest OS power state is unknown. This class attribute was added in +vSphere API 6.7.

+
+ +
+ +
+
+get(vm)
+

Returns information about the guest operating system power state. This +method was added in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Power.Info

+
+
Returns
+

Guest OS powerstate information.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+
+reboot(vm)
+

Issues a request to the guest operating system asking it to perform a +reboot. This request returns immediately and does not wait for the +guest operating system to complete the operation. This method was added +in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual machine does not support being powered on (e.g. +marked as a template, serving as a fault-tolerance secondary +virtual machine).

+
+
+
+ +
+
+shutdown(vm)
+

Issues a request to the guest operating system asking it to perform a +clean shutdown of all services. This request returns immediately and +does not wait for the guest operating system to complete the operation. +This method was added in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual machine does not support being powered on (e.g. +marked as a template, serving as a fault-tolerance secondary +virtual machine).

+
+
+
+ +
+
+standby(vm)
+

Issues a request to the guest operating system asking it to perform a +suspend operation. This method was added in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual machine is suspended.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if VMware Tools is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the virtual machine does not support being powered on (e.g. +marked as a template, serving as a fault-tolerance secondary +virtual machine).

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.Processes(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Processes class provides methods to manage processes in the guest +operating system. This class was added in vSphere API 7.0.2.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(path=None, arguments=None, working_directory=None, environment_variables=None, start_minimized=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Processes.CreateSpec class describes the arguments to +Processes.create(). This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • path (str) –

    The absolute path to the program to start.

    +

    For Linux guest operating systems, /bin/bash is used to start the +program.

    +

    For Solaris guest operating systems, if /bin/bash exists, its used +to start the program, otherwise /bin/sh is used. If /bin/sh is +used, then the process ID returned by Processes.create() will +be that of the shell used to start the program, rather than the +program itself, due to the differences in how /bin/sh and /bin/bash +work. This PID will still be usable for watching the process with +Processes.list() to find its exit code and elapsed time.

    +

    For Windows, no shell is used. Using a simple batch file instead by +prepending c:\windows\system32\cmd.exe /c will allow stdio +redirection to work if passed in the arguments parameter.. This +attribute was added in vSphere API 7.0.2.0.

    +

    • +

  • arguments (str or None) –

    The arguments to the program.

    +

    Characters which must be escaped to the shell should also be +escaped in arguments.

    +

    In Linux and Solaris guest operating systems, stdio redirection +arguments may be used.

    +

    For Windows, stdio redirection can be added to the argments if +path is prefixed with c:\windows\system32\cmd.exe /c.. This +attribute was added in vSphere API 7.0.2.0. +If None no arguments are passed to the program.

    +

    • +

  • working_directory (str or None) – The absolute path of the working directory for the program to be +run. VMware recommends explicitly setting the working directory for +the program to be run. This attribute was added in vSphere API +7.0.2.0. +If None or is an empty string, the behavior depends on the guest +operating system. For Linux guest operating systems, if None or is +an empty string, the working directory will be the home directory +of the user associated with the guest authentication. For other +guest operating systems, if None, the behavior is unspecified.

    • +

  • environment_variables ((dict of str and str) or None) – A map of environment variables, specified using the guest OS rules +(for example PATH, c:in;c:\windows\system32 or +LD_LIBRARY_PATH,/usr/lib:/lib), to be set for the program being +run. Note that these are not additions to the default environment +variables; they define the complete set available to the program. +This attribute was added in vSphere API 7.0.2.0. +If None, the environment variables used are guest dependent +defaults.

    • +

  • start_minimized (bool or None) – Makes any program window start minimized in Windows operating +systems. Returns an error if set for non-Windows guests. +This attribute was added in vSphere API 7.0.2.0. +Defaults to false.

    • +
+
+
+
+ +
+
+class Info(name=None, owner=None, command=None, started=None, finished=None, exit_code=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Processes.Info class describes the state of a guest process. This +class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The process name. This attribute was added in vSphere API 7.0.2.0.

    • +

  • owner (str) – The process owner. This attribute was added in vSphere API 7.0.2.0.

    • +

  • command (str) – The full command line of the process. This attribute was added in +vSphere API 7.0.2.0.

    • +

  • started (datetime.datetime) – The start time of the process. This attribute was added in vSphere +API 7.0.2.0.

    • +

  • finished (datetime.datetime or None) – If the process was started using Processes.create() then the +process completion time will be available if queried within 5 +minutes after it completes. This attribute was added in vSphere API +7.0.2.0. +Set if the process was started with Processes.create() and +has recently exited.

    • +

  • exit_code (long or None) – If the process was started using Processes.create() then the +process exit code will be available if queried within 5 minutes +after it completes. This attribute was added in vSphere API +7.0.2.0. +Set if the process was started with Processes.create() and +has recently exited.

    • +
+
+
+
+ +
+
+class ProcessErrorDetails(pid=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Processes.ProcessErrorDetails class describes additional error +information for process operations. This class was added in vSphere API +7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

pid (long) – The process associated with the error. This attribute was added in +vSphere API 7.0.2.0.

+
+
+
+ +
+
+class Summary(name=None, pid=None, owner=None, command=None, started=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Processes.Summary class describes the state of a guest process. +This class was added in vSphere API 7.0.2.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str) – The process name. This attribute was added in vSphere API 7.0.2.0.

    • +

  • pid (long) – The process ID. This attribute was added in vSphere API 7.0.2.0.

    • +

  • owner (str) – The process owner. This attribute was added in vSphere API 7.0.2.0.

    • +

  • command (str) – The full command line of the process. This attribute was added in +vSphere API 7.0.2.0.

    • +

  • started (datetime.datetime) – The start time of the process. This attribute was added in vSphere +API 7.0.2.0.

    • +
+
+
+
+ +
+
+create(vm, credentials, spec)
+

Starts a program in the guest operating system.

+

A process started this way can have its status queried with +Processes.list() or Processes.get(). When the process +completes, its exit code and end time will be available for 5 minutes +after completion.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (Credentials) – The guest authentication data. See Credentials. The +program will be run as the user associated with this data.

    • +

  • spec (Processes.CreateSpec) – The arguments describing the program to be started.

    • +
+
+
Return type
+

long

+
+
Returns
+

The process id of the program started.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the Processes.CreateSpec.start_minimized attribute is +set and the guest is not a Windows operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the program path is not a valid path. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the +com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the working directory is not a valid directory. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the +com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the program path does not exist. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the +com.vmware.vcenter.vm.guest.filesystem_client.FileErrorDetails +providing additional information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the program fails to start.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials was not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the path attribute of spec cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the path attribute of spec cannot be run because +credentials will not allow the operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Execute.

    • +
+
+
+
+ +
+
+delete(vm, credentials, pid)
+

Terminates a process in the guest OS.

+

On Posix guests, the process is sent a SIGTERM signal. If that doesn’t +terminate the process, a SIGKILL signal is sent. A process may still be +running if it’s stuck.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (Credentials) – The guest authentication data. See Credentials.

    • +

  • pid (long) – Process ID of the process to be terminated

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the pid is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the +Processes.ProcessErrorDetails providing additional +information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if credentials is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if credentials does not have permission to terminate the +process.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Execute.

    • +
+
+
+
+ +
+
+get(vm, credentials, pid)
+

Returns the status of a process running in the guest operating system, +including those started by Processes.create() that may have +recently completed.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (Credentials) – The guest authentication data. See Credentials.

    • +

  • pid (long) – Specifies the process to query.

    • +
+
+
Return type
+

Processes.Info

+
+
Returns
+

The for the process with id pid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the process pid is not found. The value of +com.vmware.vapi.std.errors_client.Error.data will contain +all the attributes defined in the +Processes.ProcessErrorDetails providing additional +information about the failure.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Query.

    • +
+
+
+
+ +
+
+list(vm, credentials)
+

List the processes running in the guest operating system, plus those +started by Processes.create() that have recently completed.

+

. This method was added in vSphere API 7.0.2.0.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine to perform the operation on. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • credentials (Credentials) – The guest authentication data. See Credentials.

    • +
+
+
Return type
+

list of Processes.Summary

+
+
Returns
+

The list of running processes is returned in an array of classes.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine vm is not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine vm is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the VMware tools are not running.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the credentials is not valid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is not supported by the VMware tools in the guest +OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the operation is disabled by the VMware tools in the guest OS.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.GuestOperations.Query.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.guest_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm.hardware_client module

+

The com.vmware.vcenter.vm.hardware_client module provides classes for +managing the virtual hardware configuration and state of a virtual machine. +This includes methods for reading and manipulating virtual device configuration +and for querying the runtime state of the devices.

+
+
+class com.vmware.vcenter.vm.hardware_client.Boot(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Boot class provides methods for configuring the settings used when +booting a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CreateSpec(type=None, efi_legacy_boot=None, network_protocol=None, delay=None, retry=None, retry_delay=None, enter_setup_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Boot.CreateSpec class describes settings used when booting a +virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Boot.Type or None) – Firmware type to be used by the virtual machine. +If None, defaults to value that is recommended for the guest OS and +is supported for the virtual hardware version.

    • +

  • efi_legacy_boot (bool or None) – Flag indicating whether to use EFI legacy boot mode. +If None, defaults to value that is recommended for the guest OS and +is supported for the virtual hardware version.

    • +

  • network_protocol (Boot.NetworkProtocol or None) – Protocol to use when attempting to boot the virtual machine over +the network. +If None, defaults to a system defined default value.

    • +

  • delay (long or None) – Delay in milliseconds before beginning the firmware boot process +when the virtual machine is powered on. This delay may be used to +provide a time window for users to connect to the virtual machine +console and enter BIOS setup mode. +If None, default value is 0.

    • +

  • retry (bool or None) – Flag indicating whether the virtual machine should automatically +retry the boot process after a failure. +If None, default value is false.

    • +

  • retry_delay (long or None) – Delay in milliseconds before retrying the boot process after a +failure; applicable only when Boot.Info.retry is true. +If None, default value is 10000.

    • +

  • enter_setup_mode (bool or None) – Flag indicating whether the firmware boot process should +automatically enter setup mode the next time the virtual machine +boots. Note that this flag will automatically be reset to false +once the virtual machine enters setup mode. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+class Info(type=None, efi_legacy_boot=None, network_protocol=None, delay=None, retry=None, retry_delay=None, enter_setup_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Boot.Info class contains information about the virtual machine boot +process.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Boot.Type) – Firmware type used by the virtual machine.

    • +

  • efi_legacy_boot (bool) – Flag indicating whether to use EFI legacy boot mode. +This attribute is optional and it is only relevant when the value +of type is Boot.Type.EFI.

    • +

  • network_protocol (Boot.NetworkProtocol) – Protocol to use when attempting to boot the virtual machine over +the network. +This attribute is optional and it is only relevant when the value +of type is Boot.Type.EFI.

    • +

  • delay (long) – Delay in milliseconds before beginning the firmware boot process +when the virtual machine is powered on. This delay may be used to +provide a time window for users to connect to the virtual machine +console and enter BIOS setup mode.

    • +

  • retry (bool) – Flag indicating whether the virtual machine will automatically +retry the boot process after a failure.

    • +

  • retry_delay (long) – Delay in milliseconds before retrying the boot process after a +failure; applicable only when Boot.Info.retry is true.

    • +

  • enter_setup_mode (bool) – Flag indicating whether the firmware boot process will +automatically enter setup mode the next time the virtual machine +boots. Note that this flag will automatically be reset to false +once the virtual machine enters setup mode.

    • +
+
+
+
+ +
+
+class NetworkProtocol(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Boot.NetworkProtocol class defines the valid network boot protocols +supported when booting a virtual machine with Boot.Type.EFI +firmware over the network.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the NetworkProtocol instance.

+
+
+
+
+IPV4 = NetworkProtocol(string='IPV4')
+

PXE or Apple NetBoot over IPv4.

+
+ +
+
+IPV6 = NetworkProtocol(string='IPV6')
+

PXE over IPv6.

+
+ +
+ +
+
+class Type(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Boot.Type class defines the valid firmware types for a virtual +machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Type instance.

+
+
+
+
+BIOS = Type(string='BIOS')
+

Basic Input/Output System (BIOS) firmware.

+
+ +
+
+EFI = Type(string='EFI')
+

Extensible Firmware Interface (EFI) firmware.

+
+ +
+ +
+
+class UpdateSpec(type=None, efi_legacy_boot=None, network_protocol=None, delay=None, retry=None, retry_delay=None, enter_setup_mode=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Boot.UpdateSpec class describes the updates to the settings used +when booting a virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Boot.Type or None) – Firmware type to be used by the virtual machine. +If None, the value is unchanged.

    • +

  • efi_legacy_boot (bool or None) – Flag indicating whether to use EFI legacy boot mode. +If None, the value is unchanged.

    • +

  • network_protocol (Boot.NetworkProtocol or None) – Protocol to use when attempting to boot the virtual machine over +the network. +If None, the value is unchanged.

    • +

  • delay (long or None) – Delay in milliseconds before beginning the firmware boot process +when the virtual machine is powered on. This delay may be used to +provide a time window for users to connect to the virtual machine +console and enter BIOS setup mode. +If None, the value is unchanged.

    • +

  • retry (bool or None) – Flag indicating whether the virtual machine should automatically +retry the boot process after a failure. +If None, the value is unchanged.

    • +

  • retry_delay (long or None) – Delay in milliseconds before retrying the boot process after a +failure; applicable only when Boot.Info.retry is true. +If None, the value is unchanged.

    • +

  • enter_setup_mode (bool or None) – Flag indicating whether the firmware boot process should +automatically enter setup mode the next time the virtual machine +boots. Note that this flag will automatically be reset to false +once the virtual machine enters setup mode. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+get(vm)
+

Returns the boot-related settings of a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Boot.Info

+
+
Returns
+

Boot-related settings of the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, spec)
+

Updates the boot-related settings of a virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Boot.UpdateSpec) – Specification for updating the boot-related settings of the virtual +machine.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the provided settings is not permitted; for example, +specifying a negative value for delay.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Cdrom(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Cdrom class provides methods for configuring the virtual CD-ROM +devices of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackingInfo(type=None, iso_file=None, host_device=None, auto_detect=None, device_access_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cdrom.BackingInfo class contains information about the physical +resource backing a virtual CD-ROM device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Cdrom.BackingType) – Backing type for the virtual CD-ROM device.

    • +

  • iso_file (str) – Path of the image file backing the virtual CD-ROM device. +This attribute is optional and it is only relevant when the value +of type is Cdrom.BackingType.ISO_FILE.

    • +

  • host_device (str or None) – Name of the host device backing the virtual CD-ROM device. +This attribute will be None if autoDetect is true and the +virtual CD-ROM device is not connected or no suitable device is +available on the host.

    • +

  • auto_detect (bool) – Flag indicating whether the virtual CD-ROM device is configured to +automatically detect a suitable host device. +This attribute is optional and it is only relevant when the value +of type is Cdrom.BackingType.HOST_DEVICE.

    • +

  • device_access_type (Cdrom.DeviceAccessType) – Access type for the device backing. +This attribute is optional and it is only relevant when the value +of type is one of Cdrom.BackingType.HOST_DEVICE or +Cdrom.BackingType.CLIENT_DEVICE.

    • +
+
+
+
+ +
+
+class BackingSpec(type=None, iso_file=None, host_device=None, device_access_type=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cdrom.BackingSpec class provides a specification of the physical +resource backing a virtual CD-ROM device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Cdrom.BackingType) – Backing type for the virtual CD-ROM device.

    • +

  • iso_file (str) – Path of the image file that should be used as the virtual CD-ROM +device backing. +This attribute is optional and it is only relevant when the value +of type is Cdrom.BackingType.ISO_FILE.

    • +

  • host_device (str or None) – Name of the device that should be used as the virtual CD-ROM device +backing. +If None, the virtual CD-ROM device will be configured to +automatically detect a suitable host device.

    • +

  • device_access_type (Cdrom.DeviceAccessType or None) – Access type for the device backing. +If None, defaults to Cdrom.DeviceAccessType.EMULATION.

    • +
+
+
+
+ +
+
+class BackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cdrom.BackingType class defines the valid backing types for a +virtual CD-ROM device.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackingType instance.

+
+
+
+
+CLIENT_DEVICE = BackingType(string='CLIENT_DEVICE')
+

Virtual CD-ROM device is backed by a device on the client that is connected +to the virtual machine console.

+
+ +
+
+HOST_DEVICE = BackingType(string='HOST_DEVICE')
+

Virtual CD-ROM device is backed by a device on the host where the virtual +machine is running.

+
+ +
+
+ISO_FILE = BackingType(string='ISO_FILE')
+

Virtual CD-ROM device is backed by an ISO file.

+
+ +
+ +
+
+class CreateSpec(type=None, ide=None, sata=None, backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cdrom.CreateSpec class provides a specification for the +configuration of a newly-created virtual CD-ROM device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Cdrom.HostBusAdapterType or None) – Type of host bus adapter to which the device should be attached. +If None, guest-specific default values will be used

    • +

  • ide (IdeAddressSpec or None) – Address for attaching the device to a virtual IDE adapter. +If None, the server will choose an available address; if none is +available, the request will fail.

    • +

  • sata (SataAddressSpec or None) – Address for attaching the device to a virtual SATA adapter. +If None, the server will choose an available address; if none is +available, the request will fail.

    • +

  • backing (Cdrom.BackingSpec or None) – Physical resource backing for the virtual CD-ROM device. +If None, defaults to automatic detection of a suitable host device.

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +Defaults to false if None.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +Defaults to false if None.

    • +
+
+
+
+ +
+
+class DeviceAccessType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cdrom.DeviceAccessType class defines the valid device access types +for a physical device packing of a virtual CD-ROM device.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the DeviceAccessType instance.

+
+
+
+
+EMULATION = DeviceAccessType(string='EMULATION')
+

ATAPI or SCSI device emulation.

+
+ +
+
+PASSTHRU = DeviceAccessType(string='PASSTHRU')
+

Raw passthru device access.

+
+ +
+
+PASSTHRU_EXCLUSIVE = DeviceAccessType(string='PASSTHRU_EXCLUSIVE')
+

Raw passthru device access, with exclusive access to the device.

+
+ +
+ +
+
+class HostBusAdapterType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Cdrom.HostBusAdapterType class defines the valid types of host bus +adapters that may be used for attaching a Cdrom to a virtual machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HostBusAdapterType instance.

+
+
+
+
+IDE = HostBusAdapterType(string='IDE')
+

Cdrom is attached to an IDE adapter.

+
+ +
+
+SATA = HostBusAdapterType(string='SATA')
+

Cdrom is attached to a SATA adapter.

+
+ +
+ +
+
+class Info(type=None, label=None, ide=None, sata=None, backing=None, state=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cdrom.Info class contains information about a virtual CD-ROM +device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Cdrom.HostBusAdapterType) – Type of host bus adapter to which the device is attached.

    • +

  • label (str) – Device label.

    • +

  • ide (IdeAddressInfo) – Address of device attached to a virtual IDE adapter. +This attribute is optional and it is only relevant when the value +of type is Cdrom.HostBusAdapterType.IDE.

    • +

  • sata (SataAddressInfo) – Address of device attached to a virtual SATA adapter. +This attribute is optional and it is only relevant when the value +of type is Cdrom.HostBusAdapterType.SATA.

    • +

  • backing (Cdrom.BackingInfo) – Physical resource backing for the virtual CD-ROM device.

    • +

  • state (ConnectionState) – Connection status of the virtual device.

    • +

  • start_connected (bool) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on.

    • +

  • allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the +device.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Cdrom'
+

Resource type for the virtual CD-ROM device.

+
+ +
+
+class Summary(cdrom=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cdrom.Summary class contains commonly used information about a +virtual CD-ROM device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

cdrom (str) – Identifier of the virtual CD-ROM device. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

+
+
+
+ +
+
+class UpdateSpec(backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cdrom.UpdateSpec class describes the updates to be made to the +configuration of a virtual CD-ROM device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing (Cdrom.BackingSpec or None) –

    Physical resource backing for the virtual CD-ROM device.

    +

    This attribute may only be modified if the virtual machine is not +powered on or the virtual CD-ROM device is not connected. +If None, the value is unchanged.

    +

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +If None, the value is unchanged.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+connect(vm, cdrom)
+

Connects a virtual CD-ROM device of a powered-on virtual machine to its +backing. Connecting the virtual device makes the backing accessible +from the perspective of the guest operating system.

+

For a powered-off virtual machine, the Cdrom.update() method may +be used to configure the virtual CD-ROM device to start in the +connected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • cdrom (str) – Virtual CD-ROM device identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual CD-ROM device is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual CD-ROM device is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual CD-ROM device to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Cdrom.CreateSpec) – Specification for the new virtual CD-ROM device.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual CD-ROM device identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the CD-ROM device was created but was +unable to confirm the creation because the identifier of the new +device could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended or if the virtual machine is +powered on and virtual CD-ROM type is IDE.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the specified storage address is unavailable; for example, if +the SCSI adapter requested does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the specified storage address is in use.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified storage address is out of bounds.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the guest operating system of the virtual machine is not +supported and spec includes None attributes that default to +guest-specific values.

+
+
+
+ +
+
+delete(vm, cdrom)
+

Removes a virtual CD-ROM device from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • cdrom (str) – Virtual CD-ROM device identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual CD-ROM device is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended or if the virtual machine is +powered on and virtual CD-ROM type is IDE.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+disconnect(vm, cdrom)
+

Disconnects a virtual CD-ROM device of a powered-on virtual machine +from its backing. The virtual device is still present and its backing +configuration is unchanged, but from the perspective of the guest +operating system, the CD-ROM device is not connected to its backing +resource.

+

For a powered-off virtual machine, the Cdrom.update() method may +be used to configure the virtual CD-ROM device to start in the +disconnected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • cdrom (str) – Virtual CD-ROM device identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual CD-ROM device is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual CD-ROM device is already disconnected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, cdrom)
+

Returns information about a virtual CD-ROM device.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • cdrom (str) – Virtual CD-ROM device identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +
+
+
Return type
+

Cdrom.Info

+
+
Returns
+

Information about the specified virtual CD-ROM device.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual CD-ROM device is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual CD-ROM devices +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Cdrom.Summary

+
+
Returns
+

List of commonly used information about virtual CD-ROM devices.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, cdrom, spec)
+

Updates the configuration of a virtual CD-ROM device.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • cdrom (str) – Virtual CD-ROM device identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Cdrom.

    • +

  • spec (Cdrom.UpdateSpec) – Specification for updating the virtual CD-ROM device.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual CD-ROM device is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if one or more of the attributes specified in the spec +parameter cannot be modified due to the current power state of the +virtual machine or the connection state of the virtual CD-ROM +device.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec(start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConnectionCreateSpec class provides a specification for the +configuration of a newly-created removable device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +Defaults to false if None.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +Defaults to false if None.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.ConnectionInfo(state=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConnectionInfo class provides information about the state and +configuration of a removable virtual device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • state (ConnectionState) – Connection status of the virtual device.

    • +

  • start_connected (bool) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on.

    • +

  • allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the +device.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.ConnectionState(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The ConnectionState class defines the valid states for a removable +device that is configured to be connected.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the ConnectionState instance.

+
+
+
+
+CONNECTED = ConnectionState(string='CONNECTED')
+

The device is connected and working correctly.

+
+ +
+
+NOT_CONNECTED = ConnectionState(string='NOT_CONNECTED')
+

The device is not connected.

+
+ +
+
+RECOVERABLE_ERROR = ConnectionState(string='RECOVERABLE_ERROR')
+

Device connection failed due to a recoverable error; for example, the +virtual device backing is currently in use by another virtual machine.

+
+ +
+
+UNKNOWN = ConnectionState(string='UNKNOWN')
+

The device status is unknown.

+
+ +
+
+UNRECOVERABLE_ERROR = ConnectionState(string='UNRECOVERABLE_ERROR')
+

Device connection failed due to an unrecoverable error; for example, the +virtual device backing does not exist.

+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec(start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ConnectionUpdateSpec class describes the updates to be made to the +configuration of a removable virtual device.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +If None, the value is unchanged.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Cpu(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Cpu class provides methods for configuring the CPU settings of a +virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(count=None, cores_per_socket=None, hot_add_enabled=None, hot_remove_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cpu.Info class contains CPU-related information about a virtual +machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • count (long) – Number of CPU cores.

    • +

  • cores_per_socket (long) – Number of CPU cores per socket.

    • +

  • hot_add_enabled (bool) – Flag indicating whether adding CPUs while the virtual machine is +running is enabled.

    • +

  • hot_remove_enabled (bool) – Flag indicating whether removing CPUs while the virtual machine is +running is enabled.

    • +
+
+
+
+ +
+
+class UpdateSpec(count=None, cores_per_socket=None, hot_add_enabled=None, hot_remove_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Cpu.UpdateSpec class describes the updates to be made to the +CPU-related settings of a virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • count (long or None) –

    New number of CPU cores. The number of CPU cores in the virtual +machine must be a multiple of the number of cores per socket.

    +

    The supported range of CPU counts is constrained by the configured +guest operating system and virtual hardware version of the virtual +machine.

    +

    If the virtual machine is running, the number of CPU cores may only +be increased if Cpu.Info.hot_add_enabled is true, and may +only be decreased if Cpu.Info.hot_remove_enabled is true. +If None, the value is unchanged.

    +

    • +

  • cores_per_socket (long or None) – New number of CPU cores per socket. The number of CPU cores in the +virtual machine must be a multiple of the number of cores per +socket. +If None, the value is unchanged.

    • +

  • hot_add_enabled (bool or None) –

    Flag indicating whether adding CPUs while the virtual machine is +running is enabled.

    +

    This attribute may only be modified if the virtual machine is +powered off. +If None, the value is unchanged.

    +

    • +

  • hot_remove_enabled (bool or None) –

    Flag indicating whether removing CPUs while the virtual machine is +running is enabled.

    +

    This attribute may only be modified if the virtual machine is +powered off. +If None, the value is unchanged.

    +

    • +
+
+
+
+ +
+
+get(vm)
+

Returns the CPU-related settings of a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Cpu.Info

+
+
Returns
+

CPU-related settings of the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, spec)
+

Updates the CPU-related settings of a virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Cpu.UpdateSpec) – Specification for updating the CPU-related settings of the virtual +machine.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the provided settings is not permitted; for example, +specifying a negative value for count.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if hotAddEnabled or hotRemoveEnabled is specified and the +virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if count is specified and is greater than count, +hotAddEnabled is false, and the virtual machine is not powered +off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if count is specified and is less than count, +hotRemoveEnabled is false, and the virtual machine is not +powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Disk(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Disk class provides methods for configuring the virtual disks of a +virtual machine. A virtual disk has a backing such as a VMDK file. The +backing has an independent lifecycle from the virtual machine when it is +detached from the virtual machine. The Disk.create() method provides +the ability to create a new virtual disk. When creating a virtual disk, a +new VMDK file may be created or an existing VMDK file may used as a +backing. Once a VMDK file is associated with a virtual machine, its +lifecycle will be bound to the virtual machine. In other words, it will be +deleted when the virtual machine is deleted. The Disk.delete() method +provides the ability to detach a VMDK file from the virtual machine. The +Disk.delete() method does not delete the VMDK file that backs the +virtual disk. Once detached, the VMDK file will not be destroyed when the +virtual machine to which it was associated is deleted.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackingInfo(type=None, vmdk_file=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.BackingInfo class contains information about the physical +resource backing a virtual disk.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Disk.BackingType) – Backing type for the virtual disk.

    • +

  • vmdk_file (str) – Path of the VMDK file backing the virtual disk. +This attribute is optional and it is only relevant when the value +of type is Disk.BackingType.VMDK_FILE.

    • +
+
+
+
+ +
+
+class BackingSpec(type=None, vmdk_file=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.BackingSpec class provides a specification of the physical +resource backing a virtual disk.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Disk.BackingType) – Backing type for the virtual disk.

    • +

  • vmdk_file (str) – Path of the VMDK file backing the virtual disk. +This attribute is optional and it is only relevant when the value +of type is Disk.BackingType.VMDK_FILE.

    • +
+
+
+
+ +
+
+class BackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Disk.BackingType class defines the valid backing types for a +virtual disk.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackingType instance.

+
+
+
+
+VMDK_FILE = BackingType(string='VMDK_FILE')
+

Virtual disk is backed by a VMDK file.

+
+ +
+ +
+
+class CreateSpec(type=None, ide=None, scsi=None, sata=None, nvme=None, backing=None, new_vmdk=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.CreateSpec class provides a specification for the +configuration of a newly-created virtual disk.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Disk.HostBusAdapterType or None) – Type of host bus adapter to which the device should be attached. +If None, guest-specific default values will be used

    • +

  • ide (IdeAddressSpec or None) – Address for attaching the device to a virtual IDE adapter. +If None, the server will choose an available address; if none is +available, the request will fail.

    • +

  • scsi (ScsiAddressSpec or None) – Address for attaching the device to a virtual SCSI adapter. +If None, the server will choose an available address; if none is +available, the request will fail.

    • +

  • sata (SataAddressSpec or None) – Address for attaching the device to a virtual SATA adapter. +If None, the server will choose an available address; if none is +available, the request will fail.

    • +

  • nvme (NvmeAddressSpec or None) – Address for attaching the device to a virtual NVMe adapter. This +attribute was added in vSphere API 7.0.0.1. +If None, the server will choose an available address; if none is +available, the request will fail.

    • +

  • backing (Disk.BackingSpec or None) – Existing physical resource backing for the virtual disk. Exactly +one of backing or newVmdk must be specified. +If None, the virtual disk will not be connected to an existing +backing.

    • +

  • new_vmdk (Disk.VmdkCreateSpec or None) – Specification for creating a new VMDK backing for the virtual disk. +Exactly one of backing or newVmdk must be specified. +If None, a new VMDK backing will not be created.

    • +
+
+
+
+ +
+
+class HostBusAdapterType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Disk.HostBusAdapterType class defines the valid types of host bus +adapters that may be used for attaching a virtual storage device to a +virtual machine.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the HostBusAdapterType instance.

+
+
+
+
+IDE = HostBusAdapterType(string='IDE')
+

Disk is attached to an IDE adapter.

+
+ +
+
+NVME = HostBusAdapterType(string='NVME')
+

Disk is attached to a NVMe adapter. This class attribute was added in +vSphere API 7.0.0.1.

+
+ +
+
+SATA = HostBusAdapterType(string='SATA')
+

Disk is attached to a SATA adapter.

+
+ +
+
+SCSI = HostBusAdapterType(string='SCSI')
+

Disk is attached to a SCSI adapter.

+
+ +
+ +
+
+class Info(label=None, type=None, ide=None, scsi=None, sata=None, nvme=None, backing=None, capacity=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.Info class contains information about a virtual disk.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • type (Disk.HostBusAdapterType) – Type of host bus adapter to which the device is attached.

    • +

  • ide (IdeAddressInfo) – Address of device attached to a virtual IDE adapter. +Workaround for PR1459646

    • +

  • scsi (ScsiAddressInfo) – Address of device attached to a virtual SCSI adapter. +Workaround for PR1459646

    • +

  • sata (SataAddressInfo) – Address of device attached to a virtual SATA adapter. +Workaround for PR1459646

    • +

  • nvme (NvmeAddressInfo) – Address of device attached to a virtual NVMe adapter. This +attribute was added in vSphere API 7.0.0.1. +This attribute is optional and it is only relevant when the value +of type is Disk.HostBusAdapterType.NVME.

    • +

  • backing (Disk.BackingInfo) – Physical resource backing for the virtual disk.

    • +

  • capacity (long or None) – Capacity of the virtual disk in bytes. +If None, virtual disk is inaccessible or disk capacity is 0.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Disk'
+

Resource type for the virtual disk.

+
+ +
+
+class StoragePolicySpec(policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.StoragePolicySpec class contains information about the storage +policy be associated with a VMDK file. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

policy (str) – Identifier of the storage policy which should be associated with +the VMDK file. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy.

+
+
+
+ +
+
+class Summary(disk=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.Summary class contains commonly used information about a +virtual disk.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

disk (str) – Identifier of the virtual Disk. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

+
+
+
+ +
+
+class UpdateSpec(backing=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.UpdateSpec class describes the updates to be made to the +configuration of a virtual disk.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

backing (Disk.BackingSpec or None) –

Physical resource backing for the virtual disk.

+

This attribute may only be modified if the virtual machine is not +powered on. +If None, the value is unchanged.

+

+
+
+
+ +
+
+class VmdkCreateSpec(name=None, capacity=None, storage_policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Disk.VmdkCreateSpec class provides a specification for creating a +new VMDK file to be used as a backing for a virtual disk. The virtual disk +will be stored in the same directory as the virtual machine’s configuration +file.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Base name of the VMDK file. The name should not include the ‘.vmdk’ +file extension. +If None, a name (derived from the name of the virtual machine) will +be chosen by the server.

    • +

  • capacity (long or None) – Capacity of the virtual disk backing in bytes. +If None, defaults to a guest-specific capacity.

    • +

  • storage_policy (Disk.StoragePolicySpec or None) – The Disk.StoragePolicySpec class contains information about the +storage policy that is to be associated the with VMDK file. This +attribute was added in vSphere API 6.7. +If None the default storage policy of the target datastore (if +applicable) is applied. Currently a default storage policy is only +supported by object based datastores : VVol & vSAN. For non- object +datastores, if None then no storage policy would be associated with +the VMDK file.

    • +
+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual disk to the virtual machine. While adding the virtual +disk, a new VMDK file may be created or an existing VMDK file may be +used to back the virtual disk.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Disk.CreateSpec) – Specification for the new virtual disk.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual disk identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if system reported that the disk device was created but was unable +to confirm the creation because the identifier of the new device +could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended or if the virtual machine is +powered on and virtual disk type is IDE.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the specified storage address is unavailable; for example, if +the SCSI adapter requested does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInUse +if the specified storage address is in use.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified storage address is out of bounds or if the +specified storage policy is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the guest operating system of the virtual machine is not +supported and spec includes None attributes that default to +guest-specific values.

+
+
+
+ +
+
+delete(vm, disk)
+

Removes a virtual disk from the virtual machine. This method does not +destroy the VMDK file that backs the virtual disk. It only detaches the +VMDK file from the virtual machine. Once detached, the VMDK file will +not be destroyed when the virtual machine to which it was associated is +deleted.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • disk (str) – Virtual disk identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual disk is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is suspended or if the virtual machine is +powered on and virtual disk type is IDE.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, disk)
+

Returns information about a virtual disk.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • disk (str) – Virtual disk identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +
+
+
Return type
+

Disk.Info

+
+
Returns
+

Information about the specified virtual disk.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual disk is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual disks belonging to +the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Disk.Summary

+
+
Returns
+

List of commonly used information about the virtual disks.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, disk, spec)
+

Updates the configuration of a virtual disk. An update method can be +used to detach the existing VMDK file and attach another VMDK file to +the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • disk (str) – Virtual disk identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +

  • spec (Disk.UpdateSpec) – Specification for updating the virtual disk.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual disk is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if one or more of the attributes specified in the spec +parameter cannot be modified due to the current power state of the +virtual machine or the connection state of the virtual disk.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Ethernet(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Ethernet class provides methods for configuring the virtual +Ethernet adapters of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackingInfo(type=None, network=None, network_name=None, host_device=None, distributed_switch_uuid=None, distributed_port=None, connection_cookie=None, opaque_network_type=None, opaque_network_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ethernet.BackingInfo class contains information about the physical +resource backing a virtual Ethernet adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Ethernet.BackingType) – Backing type for the virtual Ethernet adapter.

    • +

  • network (str or None) – Identifier of the network backing the virtual Ethernet adapter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network. +If None, the identifier of the network backing could not be +determined.

    • +

  • network_name (str) – Name of the standard portgroup backing the virtual Ethernet +adapter. +This attribute is optional and it is only relevant when the value +of type is Ethernet.BackingType.STANDARD_PORTGROUP.

    • +

  • host_device (str) – Name of the device backing the virtual Ethernet adapter. +This attribute is optional and it is only relevant when the value +of type is Ethernet.BackingType.HOST_DEVICE.

    • +

  • distributed_switch_uuid (str) – UUID of the distributed virtual switch that backs the virtual +Ethernet adapter. +This attribute is optional and it is only relevant when the value +of type is Ethernet.BackingType.DISTRIBUTED_PORTGROUP.

    • +

  • distributed_port (str or None) – Key of the distributed virtual port that backs the virtual Ethernet +adapter. +This attribute will be None if the virtual Ethernet device is not +bound to a distributed virtual port; this can happen if the virtual +machine is powered off or the virtual Ethernet device is not +connected.

    • +

  • connection_cookie (long or None) – Server-generated cookie that identifies the connection to the port. +This ookie may be used to verify that the virtual machine is the +rightful owner of the port. +This attribute will be None if the virtual Ethernet device is not +bound to a distributed virtual port; this can happen if the virtual +machine is powered off or the virtual Ethernet device is not +connected.

    • +

  • opaque_network_type (str) – Type of the opaque network that backs the virtual Ethernet adapter. +This attribute is optional and it is only relevant when the value +of type is Ethernet.BackingType.OPAQUE_NETWORK.

    • +

  • opaque_network_id (str) – Identifier of the opaque network that backs the virtual Ethernet +adapter. +This attribute is optional and it is only relevant when the value +of type is Ethernet.BackingType.OPAQUE_NETWORK.

    • +
+
+
+
+ +
+
+class BackingSpec(type=None, network=None, distributed_port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ethernet.BackingSpec class provides a specification of the physical +resource that backs a virtual Ethernet adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Ethernet.BackingType) – Backing type for the virtual Ethernet adapter.

    • +

  • network (str) – Identifier of the network that backs the virtual Ethernet adapter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: Network. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Network. +This attribute is optional and it is only relevant when the value +of type is one of +Ethernet.BackingType.STANDARD_PORTGROUP, +Ethernet.BackingType.DISTRIBUTED_PORTGROUP, or +Ethernet.BackingType.OPAQUE_NETWORK.

    • +

  • distributed_port (str or None) – Key of the distributed virtual port that backs the virtual Ethernet +adapter. Depending on the type of the Portgroup, the port may be +specified using this field. If the portgroup type is early-binding +(also known as static), a port is assigned when the Ethernet +adapter is configured to use the port. The port may be either +automatically or specifically assigned based on the value of this +attribute. If the portgroup type is ephemeral, the port is created +and assigned to a virtual machine when it is powered on and the +Ethernet adapter is connected. This attribute cannot be specified +as no free ports exist before use. +May be used to specify a port when the network specified on the +network attribute is a static or early binding distributed +portgroup. If None, the port will be automatically assigned to the +Ethernet adapter based on the policy embodied by the portgroup +type.

    • +
+
+
+
+ +
+
+class BackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ethernet.BackingType class defines the valid backing types for a +virtual Ethernet adapter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackingType instance.

+
+
+
+
+DISTRIBUTED_PORTGROUP = BackingType(string='DISTRIBUTED_PORTGROUP')
+

Distributed virtual switch backing.

+
+ +
+
+HOST_DEVICE = BackingType(string='HOST_DEVICE')
+

Legacy host device network backing. Imported VMs may have virtual Ethernet +adapters with this type of backing, but this type of backing cannot be used +to create or to update a virtual Ethernet adapter.

+
+ +
+
+OPAQUE_NETWORK = BackingType(string='OPAQUE_NETWORK')
+

Opaque network backing.

+
+ +
+
+STANDARD_PORTGROUP = BackingType(string='STANDARD_PORTGROUP')
+

vSphere standard portgroup network backing.

+
+ +
+ +
+
+class CreateSpec(type=None, upt_compatibility_enabled=None, mac_type=None, mac_address=None, pci_slot_number=None, wake_on_lan_enabled=None, backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ethernet.CreateSpec class provides a specification for the +configuration of a newly-created virtual Ethernet adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Ethernet.EmulationType or None) – Ethernet adapter emulation type. +If None, defaults to a guest-specific type.

    • +

  • upt_compatibility_enabled (bool or None) – Flag indicating whether Universal Pass-Through (UPT) compatibility +is enabled on this virtual Ethernet adapter. +If None, UPT will not be enabled on the newly-created virtual +Ethernet adapter.

    • +

  • mac_type (Ethernet.MacAddressType or None) – MAC address type. +If None, defaults to Ethernet.MacAddressType.GENERATED.

    • +

  • mac_address (str) – MAC address. +Workaround for PR1459647

    • +

  • pci_slot_number (long or None) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI +address is invalid, the server will change when it the VM is +started or as the device is hot added. +If None, the server will choose an available address when the +virtual machine is powered on.

    • +

  • wake_on_lan_enabled (bool or None) – Flag indicating whether wake-on-LAN is enabled on this virtual +Ethernet adapter. +Defaults to false if None.

    • +

  • backing (Ethernet.BackingSpec or None) – Physical resource backing for the virtual Ethernet adapter. +If None, the system may try to find an appropriate backing. If one +is not found, the request will fail.

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +Defaults to false if None.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +Defaults to false if None.

    • +
+
+
+
+ +
+
+class EmulationType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ethernet.EmulationType class defines the valid emulation types for +a virtual Ethernet adapter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the EmulationType instance.

+
+
+
+
+E1000 = EmulationType(string='E1000')
+

E1000 ethernet adapter.

+
+ +
+
+E1000E = EmulationType(string='E1000E')
+

E1000e ethernet adapter.

+
+ +
+
+PCNET32 = EmulationType(string='PCNET32')
+

AMD Lance PCNet32 Ethernet adapter.

+
+ +
+
+VMXNET = EmulationType(string='VMXNET')
+

VMware Vmxnet virtual Ethernet adapter.

+
+ +
+
+VMXNET2 = EmulationType(string='VMXNET2')
+

VMware Vmxnet2 virtual Ethernet adapter.

+
+ +
+
+VMXNET3 = EmulationType(string='VMXNET3')
+

VMware Vmxnet3 virtual Ethernet adapter.

+
+ +
+ +
+
+class Info(label=None, type=None, upt_compatibility_enabled=None, mac_type=None, mac_address=None, pci_slot_number=None, wake_on_lan_enabled=None, backing=None, state=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ethernet.Info class contains information about a virtual Ethernet +adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • type (Ethernet.EmulationType) – Ethernet adapter emulation type.

    • +

  • upt_compatibility_enabled (bool) – Flag indicating whether Universal Pass-Through (UPT) compatibility +is enabled on this virtual Ethernet adapter. +This attribute is optional and it is only relevant when the value +of type is Ethernet.EmulationType.VMXNET3.

    • +

  • mac_type (Ethernet.MacAddressType) – MAC address type.

    • +

  • mac_address (str or None) – MAC address. +May be None if Ethernet.Info.mac_type is +Ethernet.MacAddressType.MANUAL and has not been specified, +or if Ethernet.Info.mac_type is +Ethernet.MacAddressType.GENERATED and the virtual machine +has never been powered on since the Ethernet adapter was created.

    • +

  • pci_slot_number (long or None) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI +address is invalid, the server will change it when the VM is +started or as the device is hot added. +May be None if the virtual machine has never been powered on since +the adapter was created.

    • +

  • wake_on_lan_enabled (bool) – Flag indicating whether wake-on-LAN is enabled on this virtual +Ethernet adapter.

    • +

  • backing (Ethernet.BackingInfo) – Physical resource backing for the virtual Ethernet adapter.

    • +

  • state (ConnectionState) – Connection status of the virtual device.

    • +

  • start_connected (bool) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on.

    • +

  • allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the +device.

    • +
+
+
+
+ +
+
+class MacAddressType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Ethernet.MacAddressType class defines the valid MAC address origins +for a virtual Ethernet adapter.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the MacAddressType instance.

+
+
+
+
+ASSIGNED = MacAddressType(string='ASSIGNED')
+

MAC address is assigned by vCenter Server.

+
+ +
+
+GENERATED = MacAddressType(string='GENERATED')
+

MAC address is generated automatically.

+
+ +
+
+MANUAL = MacAddressType(string='MANUAL')
+

MAC address is assigned statically.

+
+ +
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Ethernet'
+

Resource type for the virtual Ethernet adapter.

+
+ +
+
+class Summary(nic=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ethernet.Summary class contains commonly used information about a +virtual Ethernet adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

nic (str) – Identifier of the virtual Ethernet adapter. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

+
+
+
+ +
+
+class UpdateSpec(upt_compatibility_enabled=None, mac_type=None, mac_address=None, wake_on_lan_enabled=None, backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Ethernet.UpdateSpec class describes the updates to be made to the +configuration of a virtual Ethernet adapter.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • upt_compatibility_enabled (bool or None) –

    Flag indicating whether Universal Pass-Through (UPT) compatibility +should be enabled on this virtual Ethernet adapter.

    +

    This attribute may be modified at any time, and changes will be +applied the next time the virtual machine is powered on. +If None, the value is unchanged. Must be None if the emulation type +of the virtual Ethernet adapter is not +Ethernet.EmulationType.VMXNET3.

    +

    • +

  • mac_type (Ethernet.MacAddressType or None) –

    MAC address type.

    +

    This attribute may be modified at any time, and changes will be +applied the next time the virtual machine is powered on. +If None, the value is unchanged.

    +

    • +

  • mac_address (str or None) –

    MAC address.

    +

    This attribute may be modified at any time, and changes will be +applied the next time the virtual machine is powered on. +If None, the value is unchanged. Must be specified if +Ethernet.UpdateSpec.mac_type is +Ethernet.MacAddressType.MANUAL. Must be None if the MAC +address type is not Ethernet.MacAddressType.MANUAL.

    +

    • +

  • wake_on_lan_enabled (bool or None) –

    Flag indicating whether wake-on-LAN shoud be enabled on this +virtual Ethernet adapter.

    +

    This attribute may be modified at any time, and changes will be +applied the next time the virtual machine is powered on. +If None, the value is unchanged.

    +

    • +

  • backing (Ethernet.BackingSpec or None) –

    Physical resource backing for the virtual Ethernet adapter.

    +

    This attribute may be modified at any time, and changes will be +applied the next time the virtual machine is powered on. +If None, the value is unchanged.

    +

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +If None, the value is unchanged.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+connect(vm, nic)
+

Connects a virtual Ethernet adapter of a powered-on virtual machine to +its backing. Connecting the virtual device makes the backing accessible +from the perspective of the guest operating system.

+

For a powered-off virtual machine, the Ethernet.update() method +may be used to configure the virtual Ethernet adapter to start in the +connected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • nic (str) – Virtual Ethernet adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual Ethernet adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual Ethernet adapter is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual Ethernet adapter to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Ethernet.CreateSpec) – Specification for the new virtual Ethernet adapter.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual Ethernet adapter identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the Ethernet adapter was created but +was unable to confirm the creation because the identifier of the +new adapter could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or network backing is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the virtual machine already has the maximum number of supported +Ethernet adapters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified PCI address is out of bounds, HOST_DEVICE is +specified as the type, or a backing cannot be found in the case +that backing is left None.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unsupported +if the guest operating system of the virtual machine is not +supported and spec includes None attributes that default to +guest-specific values.

+
+
+
+ +
+
+delete(vm, nic)
+

Removes a virtual Ethernet adapter from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • nic (str) – Virtual Ethernet adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual Ethernet adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+disconnect(vm, nic)
+

Disconnects a virtual Ethernet adapter of a powered-on virtual machine +from its backing. The virtual device is still present and its backing +configuration is unchanged, but from the perspective of the guest +operating system, the Ethernet adapter is not connected to its backing +resource.

+

For a powered-off virtual machine, the Ethernet.update() method +may be used to configure the virtual Ethernet adapter to start in the +disconnected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • nic (str) – Virtual Ethernet adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual Ethernet adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual Ethernet adapter is already disconnected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, nic)
+

Returns information about a virtual Ethernet adapter.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • nic (str) – Virtual Ethernet adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

    • +
+
+
Return type
+

Ethernet.Info

+
+
Returns
+

Information about the specified virtual Ethernet adapter.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual Ethernet adapter is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual Ethernet adapters +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Ethernet.Summary

+
+
Returns
+

List of commonly used information about virtual Ethernet adapters.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, nic, spec)
+

Updates the configuration of a virtual Ethernet adapter.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • nic (str) – Virtual Ethernet adapter identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Ethernet.

    • +

  • spec (Ethernet.UpdateSpec) – Specification for updating the virtual Ethernet adapter.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if HOST_DEVICE is specified as the type.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine, virtual Ethernet adapter, or backing +network is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Floppy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Floppy class provides methods for configuring the virtual floppy +drives of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackingInfo(type=None, image_file=None, host_device=None, auto_detect=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Floppy.BackingInfo class contains information about the physical +resource backing a virtual floppy drive.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Floppy.BackingType) – Backing type for the virtual floppy drive.

    • +

  • image_file (str) – Path of the image file backing the virtual floppy drive. +This attribute is optional and it is only relevant when the value +of type is Floppy.BackingType.IMAGE_FILE.

    • +

  • host_device (str or None) – Name of the host device backing the virtual floppy drive. +This attribute will be None if autoDetect is true and the +virtual floppy drive is not connected or no suitable device is +available on the host.

    • +

  • auto_detect (bool) – Flag indicating whether the virtual floppy drive is configured to +automatically detect a suitable host device. +This attribute is optional and it is only relevant when the value +of type is Floppy.BackingType.HOST_DEVICE.

    • +
+
+
+
+ +
+
+class BackingSpec(type=None, image_file=None, host_device=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Floppy.BackingSpec class provides a specification of the physical +resource backing a virtual floppy drive.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Floppy.BackingType) – Backing type for the virtual floppy drive.

    • +

  • image_file (str) – Path of the image file that should be used as the virtual floppy +drive backing. +This attribute is optional and it is only relevant when the value +of type is Floppy.BackingType.IMAGE_FILE.

    • +

  • host_device (str or None) – Name of the device that should be used as the virtual floppy drive +backing. +If None, the virtual floppy drive will be configured to +automatically detect a suitable host device.

    • +
+
+
+
+ +
+
+class BackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Floppy.BackingType class defines the valid backing types for a +virtual floppy drive.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackingType instance.

+
+
+
+
+CLIENT_DEVICE = BackingType(string='CLIENT_DEVICE')
+

Virtual floppy drive is backed by a device on the client that is connected +to the virtual machine console.

+
+ +
+
+HOST_DEVICE = BackingType(string='HOST_DEVICE')
+

Virtual floppy drive is backed by a device on the host where the virtual +machine is running.

+
+ +
+
+IMAGE_FILE = BackingType(string='IMAGE_FILE')
+

Virtual floppy drive is backed by an image file.

+
+ +
+ +
+
+class CreateSpec(backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Floppy.CreateSpec class provides a specification for the +configuration of a newly-created virtual floppy drive.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing (Floppy.BackingSpec or None) – Physical resource backing for the virtual floppy drive. +If None, defaults to automatic detection of a suitable host device.

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +Defaults to false if None.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +Defaults to false if None.

    • +
+
+
+
+ +
+
+class Info(label=None, backing=None, state=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Floppy.Info class contains information about a virtual floppy +drive.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • backing (Floppy.BackingInfo) – Physical resource backing for the virtual floppy drive.

    • +

  • state (ConnectionState) – Connection status of the virtual device.

    • +

  • start_connected (bool) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on.

    • +

  • allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the +device.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Floppy'
+

Resource type for the virtual floppy drive device.

+
+ +
+
+class Summary(floppy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Floppy.Summary class contains commonly used information about a +virtual floppy drive.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

floppy (str) – Identifier of the virtual floppy drive. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

+
+
+
+ +
+
+class UpdateSpec(backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Floppy.UpdateSpec class describes the updates to be made to the +configuration of a virtual floppy drive.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing (Floppy.BackingSpec or None) –

    Physical resource backing for the virtual floppy drive.

    +

    This attribute may only be modified if the virtual machine is not +powered on or the virtual floppy drive is not connected. +If None, the value is unchanged.

    +

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +If None, the value is unchanged.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+connect(vm, floppy)
+

Connects a virtual floppy drive of a powered-on virtual machine to its +backing. Connecting the virtual device makes the backing accessible +from the perspective of the guest operating system.

+

For a powered-off virtual machine, the Floppy.update() method may +be used to configure the virtual floppy drive to start in the connected +state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • floppy (str) – Virtual floppy drive identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual floppy drive is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual floppy drive is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual floppy drive to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Floppy.CreateSpec) – Specification for the new virtual floppy drive.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual floppy drive identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the floppy device was created but was +unable to confirm the creation because the identifier of the new +device could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the virtual machine already has the maximum number of supported +floppy drives.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+delete(vm, floppy)
+

Removes a virtual floppy drive from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • floppy (str) – Virtual floppy drive identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual floppy drive is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+disconnect(vm, floppy)
+

Disconnects a virtual floppy drive of a powered-on virtual machine from +its backing. The virtual device is still present and its backing +configuration is unchanged, but from the perspective of the guest +operating system, the floppy drive is not connected to its backing +resource.

+

For a powered-off virtual machine, the Floppy.update() method may +be used to configure the virtual floppy floppy to start in the +disconnected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • floppy (str) – Virtual floppy drive identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual floppy drive is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual floppy drive is already disconnected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, floppy)
+

Returns information about a virtual floppy drive.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • floppy (str) – Virtual floppy drive identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

    • +
+
+
Return type
+

Floppy.Info

+
+
Returns
+

Information about the specified virtual floppy drive.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual floppy drive is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual floppy drives +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Floppy.Summary

+
+
Returns
+

List of commonly used information about virtual floppy drives.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, floppy, spec)
+

Updates the configuration of a virtual floppy drive.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • floppy (str) – Virtual floppy drive identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Floppy.

    • +

  • spec (Floppy.UpdateSpec) – Specification for updating the virtual floppy drive.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual floppy drive is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if one or more of the attributes specified in the spec +parameter cannot be modified due to the current power state of the +virtual machine or the connection state of the virtual floppy +drive.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.IdeAddressInfo(primary=None, master=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IdeAddressInfo class contains information about the address of a +virtual device that is attached to a virtual IDE adapter of a virtual +machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • primary (bool) – Flag specifying whether the device is attached to the primary or +secondary IDE adapter of the virtual machine.

    • +

  • master (bool) – Flag specifying whether the device is the master or slave device on +the IDE adapter.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.IdeAddressSpec(primary=None, master=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The IdeAddressSpec class contains information for specifying the +address of a virtual device that is attached to a virtual IDE adapter of a +virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • primary (bool or None) – Flag specifying whether the device should be attached to the +primary or secondary IDE adapter of the virtual machine. +If None, the server will choose a adapter with an available +connection. If no IDE connections are available, the request will +be rejected.

    • +

  • master (bool or None) – Flag specifying whether the device should be the master or slave +device on the IDE adapter. +If None, the server will choose an available connection type. If no +IDE connections are available, the request will be rejected.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Memory(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Memory class provides methods for configuring the memory settings +of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(size_mib=None, hot_add_enabled=None, hot_add_increment_size_mib=None, hot_add_limit_mib=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Memory.Info class contains memory-related information about a +virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size_mib (long) – Memory size in mebibytes.

    • +

  • hot_add_enabled (bool) –

    Flag indicating whether adding memory while the virtual machine is +running is enabled.

    +

    Some guest operating systems may consume more resources or perform +less efficiently when they run on hardware that supports adding +memory while the machine is running.

    +

    • +

  • hot_add_increment_size_mib (long or None) –

    The granularity, in mebibytes, at which memory can be added to a +running virtual machine.

    +

    When adding memory to a running virtual machine, the amount of +memory added must be at least +Memory.Info.hot_add_increment_size_mib and the total memory +size of the virtual machine must be a multiple of +{\@link>hotAddIncrementSize}. +Only set when Memory.Info.hot_add_enabled is true and the +virtual machine is running.

    +

    • +

  • hot_add_limit_mib (long or None) – The maximum amount of memory, in mebibytes, that can be added to a +running virtual machine. +Only set when Memory.Info.hot_add_enabled is true and the +virtual machine is running.

    • +
+
+
+
+ +
+
+class UpdateSpec(size_mib=None, hot_add_enabled=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Memory.UpdateSpec class describes the updates to be made to the +memory-related settings of a virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • size_mib (long or None) –

    New memory size in mebibytes.

    +

    The supported range of memory sizes is constrained by the +configured guest operating system and virtual hardware version of +the virtual machine.

    +

    If the virtual machine is running, this value may only be changed +if Memory.Info.hot_add_enabled is true, and the new memory +size must satisfy the constraints specified by +Memory.Info.hot_add_increment_size_mib and +Memory.Info.hot_add_limit_mib. +If None, the value is unchanged.

    +

    • +

  • hot_add_enabled (bool or None) –

    Flag indicating whether adding memory while the virtual machine is +running should be enabled.

    +

    Some guest operating systems may consume more resources or perform +less efficiently when they run on hardware that supports adding +memory while the machine is running.

    +

    This attribute may only be modified if the virtual machine is not +powered on. +If None, the value is unchanged.

    +

    • +
+
+
+
+ +
+
+get(vm)
+

Returns the memory-related settings of a virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Memory.Info

+
+
Returns
+

Memory-related settings of the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, spec)
+

Updates the memory-related settings of a virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Memory.UpdateSpec) – Specification for updating the memory-related settings of the +virtual machine.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if one of the provided settings is not permitted; for example, +specifying a negative value for sizeMiB.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if hotAddEnabled is specified and the virtual machine is not +powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if sizeMiB is specified, hotAddEnabled is false, and the +virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.NvmeAddressInfo(bus=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NvmeAddressInfo class contains information about the address of a +virtual device that is attached to a virtual NVMe adapter of a virtual +machine. This class was added in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long) – Bus number of the adapter to which the device is attached. This +attribute was added in vSphere API 7.0.0.1.

    • +

  • unit (long) – Unit number of the device. This attribute was added in vSphere API +7.0.0.1.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.NvmeAddressSpec(bus=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The NvmeAddressSpec class contains information for specifying the +address of a virtual device that is attached to a virtual NVMe adapter of a +virtual machine. This class was added in vSphere API 7.0.0.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long) – Bus number of the adapter to which the device should be attached. +This attribute was added in vSphere API 7.0.0.1.

    • +

  • unit (long or None) – Unit number of the device. This attribute was added in vSphere API +7.0.0.1. +If None, the server will choose an available unit number on the +specified adapter. If there are no available connections on the +adapter, the request will be rejected.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Parallel(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Parallel class provides methods for configuring the virtual +parallel ports of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackingInfo(type=None, file=None, host_device=None, auto_detect=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Parallel.BackingInfo class contains information about the physical +resource backing a virtual parallel port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Parallel.BackingType) – Backing type for the virtual parallel port.

    • +

  • file (str) – Path of the file backing the virtual parallel port. +This attribute is optional and it is only relevant when the value +of type is Parallel.BackingType.FILE.

    • +

  • host_device (str or None) – Name of the device backing the virtual parallel port. +This attribute will be None if autoDetect is true and the +virtual parallel port is not connected or no suitable device is +available on the host.

    • +

  • auto_detect (bool) – Flag indicating whether the virtual parallel port is configured to +automatically detect a suitable host device. +This attribute is optional and it is only relevant when the value +of type is Parallel.BackingType.HOST_DEVICE.

    • +
+
+
+
+ +
+
+class BackingSpec(type=None, file=None, host_device=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Parallel.BackingSpec class provides a specification of the physical +resource backing a virtual parallel port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Parallel.BackingType) – Backing type for the virtual parallel port.

    • +

  • file (str) – Path of the file that should be used as the virtual parallel port +backing. +This attribute is optional and it is only relevant when the value +of type is Parallel.BackingType.FILE.

    • +

  • host_device (str or None) – Name of the device that should be used as the virtual parallel port +backing. +If None, the virtual parallel port will be configured to +automatically detect a suitable host device.

    • +
+
+
+
+ +
+
+class BackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Parallel.BackingType class defines the valid backing types for a +virtual parallel port.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackingType instance.

+
+
+
+
+FILE = BackingType(string='FILE')
+

Virtual parallel port is backed by a file.

+
+ +
+
+HOST_DEVICE = BackingType(string='HOST_DEVICE')
+

Virtual parallel port is backed by a device on the host where the virtual +machine is running.

+
+ +
+ +
+
+class CreateSpec(backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Parallel.CreateSpec class provides a specification for the +configuration of a newly-created virtual parallel port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing (Parallel.BackingSpec or None) – Physical resource backing for the virtual parallel port. +If None, defaults to automatic detection of a suitable host device.

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +Defaults to false if None.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +Defaults to false if None.

    • +
+
+
+
+ +
+
+class Info(label=None, backing=None, state=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Parallel.Info class contains information about a virtual parallel +port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • backing (Parallel.BackingInfo) – Physical resource backing for the virtual parallel port.

    • +

  • state (ConnectionState) – Connection status of the virtual device.

    • +

  • start_connected (bool) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on.

    • +

  • allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the +device.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.ParallelPort'
+

Resource type for the virtual parallel port.

+
+ +
+
+class Summary(port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Parallel.Summary class contains commonly used information about a +virtual parallel port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

port (str) – Identifier of the virtual parallel port. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort. When methods +return a value of this class as a return value, the attribute will +be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

+
+
+
+ +
+
+class UpdateSpec(backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Parallel.UpdateSpec class describes the updates to be made to the +configuration of a virtual parallel port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • backing (Parallel.BackingSpec or None) –

    Physical resource backing for the virtual parallel port.

    +

    This attribute may only be modified if the virtual machine is not +powered on or the virtual parallel port is not connected. +If None, the value is unchanged.

    +

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +If None, the value is unchanged.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+connect(vm, port)
+

Connects a virtual parallel port of a powered-on virtual machine to its +backing. Connecting the virtual device makes the backing accessible +from the perspective of the guest operating system.

+

For a powered-off virtual machine, the Parallel.update() method +may be used to configure the virtual parallel port to start in the +connected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual parallel port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual parallel port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual parallel port is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual parallel port to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Parallel.CreateSpec) – Specification for the new virtual parallel port.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual parallel port identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the parallel port device was created +but was unable to confirm the creation because the identifier of +the new device could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the virtual machine already has the maximum number of supported +parallel ports.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+delete(vm, port)
+

Removes a virtual parallel port from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual parallel port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual parallel port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+disconnect(vm, port)
+

Disconnects a virtual parallel port of a powered-on virtual machine +from its backing. The virtual device is still present and its backing +configuration is unchanged, but from the perspective of the guest +operating system, the parallel port is not connected to its backing.

+

For a powered-off virtual machine, the Parallel.update() method +may be used to configure the virtual parallel port to start in the +disconnected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual parallel port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual parallel port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual parallel port is already disconnected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, port)
+

Returns information about a virtual parallel port.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual parallel port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

    • +
+
+
Return type
+

Parallel.Info

+
+
Returns
+

Information about the specified virtual parallel port.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual parallel port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual parallel ports +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Parallel.Summary

+
+
Returns
+

List of commonly used information about virtual parallel ports.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, port, spec)
+

Updates the configuration of a virtual parallel port.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual parallel port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.ParallelPort.

    • +

  • spec (Parallel.UpdateSpec) – Specification for updating the virtual parallel port.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual parallel port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if one or more of the attributes specified in the spec +parameter cannot be modified due to the current power state of the +virtual machine or the connection state of the virtual parallel +port.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.SataAddressInfo(bus=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SataAddressInfo class contains information about the address of a +virtual device that is attached to a virtual SATA adapter of a virtual +machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long) – Bus number of the adapter to which the device is attached.

    • +

  • unit (long) – Unit number of the device.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.SataAddressSpec(bus=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The SataAddressSpec class contains information for specifying the +address of a virtual device that is attached to a virtual SATA adapter of a +virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long) – Bus number of the adapter to which the device should be attached.

    • +

  • unit (long or None) – Unit number of the device. +If None, the server will choose an available unit number on the +specified adapter. If there are no available connections on the +adapter, the request will be rejected.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo(bus=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ScsiAddressInfo class contains information about the address of a +virtual device that is attached to a virtual SCSI adapter of a virtual +machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long) – Bus number of the adapter to which the device is attached.

    • +

  • unit (long) – Unit number of the device.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec(bus=None, unit=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The ScsiAddressSpec class contains information for specifying the +address of a virtual device that is attached to a virtual SCSI adapter of a +virtual machine.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • bus (long) – Bus number of the adapter to which the device should be attached.

    • +

  • unit (long or None) – Unit number of the device. +If None, the server will choose an available unit number on the +specified adapter. If there are no available connections on the +adapter, the request will be rejected.

    • +
+
+
+
+ +
+
+class com.vmware.vcenter.vm.hardware_client.Serial(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Serial class provides methods for configuring the virtual serial +ports of a virtual machine.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class BackingInfo(type=None, file=None, host_device=None, auto_detect=None, pipe=None, no_rx_loss=None, network_location=None, proxy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Serial.BackingInfo class contains information about the physical +resource backing a virtual serial port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Serial.BackingType) – Backing type for the virtual serial port.

    • +

  • file (str) – Path of the file backing the virtual serial port. +This attribute is optional and it is only relevant when the value +of type is Serial.BackingType.FILE.

    • +

  • host_device (str or None) – Name of the device backing the virtual serial port. +This attribute will be None if autoDetect is true and the +virtual serial port is not connected or no suitable device is +available on the host.

    • +

  • auto_detect (bool) – Flag indicating whether the virtual serial port is configured to +automatically detect a suitable host device. +This attribute is optional and it is only relevant when the value +of type is Serial.BackingType.HOST_DEVICE.

    • +

  • pipe (str) – Name of the pipe backing the virtual serial port. +This attribute is optional and it is only relevant when the value +of type is one of Serial.BackingType.PIPE_SERVER or +Serial.BackingType.PIPE_CLIENT.

    • +

  • no_rx_loss (bool) – Flag that enables optimized data transfer over the pipe. When the +value is true, the host buffers data to prevent data overrun. This +allows the virtual machine to read all of the data transferred over +the pipe with no data loss. +This attribute is optional and it is only relevant when the value +of type is one of Serial.BackingType.PIPE_SERVER or +Serial.BackingType.PIPE_CLIENT.

    • +

  • network_location (str) –

    URI specifying the location of the network service backing the +virtual serial port.

    +
      +

    • If Serial.BackingInfo.type is +Serial.BackingType.NETWORK_SERVER, this attribute is the +location used by clients to connect to this server. The hostname +part of the URI should either be empty or should specify the +address of the host on which the virtual machine is running.

      • +

    • If Serial.BackingInfo.type is +Serial.BackingType.NETWORK_CLIENT, this attribute is the +location used by the virtual machine to connect to the remote +server.

      • +
    +

    This attribute is optional and it is only relevant when the value +of type is one of Serial.BackingType.NETWORK_SERVER or +Serial.BackingType.NETWORK_CLIENT.

    +

    • +

  • proxy (str or None) – Proxy service that provides network access to the network backing. +If set, the virtual machine initiates a connection with the proxy +service and forwards the traffic to the proxy. +If None, no proxy service is configured.

    • +
+
+
+
+ +
+
+class BackingSpec(type=None, file=None, host_device=None, pipe=None, no_rx_loss=None, network_location=None, proxy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Serial.BackingSpec class provides a specification of the physical +resource backing a virtual serial port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Serial.BackingType) – Backing type for the virtual serial port.

    • +

  • file (str) – Path of the file backing the virtual serial port. +This attribute is optional and it is only relevant when the value +of type is Serial.BackingType.FILE.

    • +

  • host_device (str or None) – Name of the device backing the virtual serial port. +If None, the virtual serial port will be configured to +automatically detect a suitable host device.

    • +

  • pipe (str) – Name of the pipe backing the virtual serial port. +This attribute is optional and it is only relevant when the value +of type is one of Serial.BackingType.PIPE_SERVER or +Serial.BackingType.PIPE_CLIENT.

    • +

  • no_rx_loss (bool or None) – Flag that enables optimized data transfer over the pipe. When the +value is true, the host buffers data to prevent data overrun. This +allows the virtual machine to read all of the data transferred over +the pipe with no data loss. +If None, defaults to false.

    • +

  • network_location (str) –

    URI specifying the location of the network service backing the +virtual serial port.

    +
      +

    • If Serial.BackingSpec.type is +Serial.BackingType.NETWORK_SERVER, this attribute is the +location used by clients to connect to this server. The hostname +part of the URI should either be empty or should specify the +address of the host on which the virtual machine is running.

      • +

    • If Serial.BackingSpec.type is +Serial.BackingType.NETWORK_CLIENT, this attribute is the +location used by the virtual machine to connect to the remote +server.

      • +
    +

    This attribute is optional and it is only relevant when the value +of type is one of Serial.BackingType.NETWORK_SERVER or +Serial.BackingType.NETWORK_CLIENT.

    +

    • +

  • proxy (str or None) – Proxy service that provides network access to the network backing. +If set, the virtual machine initiates a connection with the proxy +service and forwards the traffic to the proxy. +If None, no proxy service should be used.

    • +
+
+
+
+ +
+
+class BackingType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Serial.BackingType class defines the valid backing types for a +virtual serial port.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the BackingType instance.

+
+
+
+
+FILE = BackingType(string='FILE')
+

Virtual serial port is backed by a file.

+
+ +
+
+HOST_DEVICE = BackingType(string='HOST_DEVICE')
+

Virtual serial port is backed by a device on the host where the virtual +machine is running.

+
+ +
+
+NETWORK_CLIENT = BackingType(string='NETWORK_CLIENT')
+

Virtual serial port is backed by a network client. This backing may be used +to create a network-accessible serial port on the virtual machine, +initiating a connection to a remote system.

+
+ +
+
+NETWORK_SERVER = BackingType(string='NETWORK_SERVER')
+

Virtual serial port is backed by a network server. This backing may be used +to create a network-accessible serial port on the virtual machine, +accepting a connection from a remote system.

+
+ +
+
+PIPE_CLIENT = BackingType(string='PIPE_CLIENT')
+

Virtual serial port is backed by a named pipe client. The virtual machine +will connect to the named pipe provided by a host application or another +virtual machine on the same host. This is useful for capturing debugging +information sent through the virtual serial port.

+
+ +
+
+PIPE_SERVER = BackingType(string='PIPE_SERVER')
+

Virtual serial port is backed by a named pipe server. The virtual machine +will accept a connection from a host application or another virtual machine +on the same host. This is useful for capturing debugging information sent +through the virtual serial port.

+
+ +
+ +
+
+class CreateSpec(yield_on_poll=None, backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Serial.CreateSpec class provides a specification for the +configuration of a newly-created virtual serial port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • yield_on_poll (bool or None) – CPU yield behavior. If set to true, the virtual machine will +periodically relinquish the processor if its sole task is polling +the virtual serial port. The amount of time it takes to regain the +processor will depend on the degree of other virtual machine +activity on the host. +If None, defaults to false.

    • +

  • backing (Serial.BackingSpec or None) – Physical resource backing for the virtual serial port. +If None, defaults to automatic detection of a suitable host device.

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +Defaults to false if None.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +Defaults to false if None.

    • +
+
+
+
+ +
+
+class Info(label=None, yield_on_poll=None, backing=None, state=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Serial.Info class contains information about a virtual serial port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • label (str) – Device label.

    • +

  • yield_on_poll (bool) – CPU yield behavior. If set to true, the virtual machine will +periodically relinquish the processor if its sole task is polling +the virtual serial port. The amount of time it takes to regain the +processor will depend on the degree of other virtual machine +activity on the host.

    • +

  • backing (Serial.BackingInfo) – Physical resource backing for the virtual serial port.

    • +

  • state (ConnectionState) – Connection status of the virtual device.

    • +

  • start_connected (bool) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on.

    • +

  • allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the +device.

    • +
+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.SerialPort'
+

Resource type for the virtual serial port device.

+
+ +
+
+class Summary(port=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Serial.Summary class contains commonly used information about a +virtual serial port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

port (str) – Identifier of the virtual serial port. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort. When methods return +a value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

+
+
+
+ +
+
+class UpdateSpec(yield_on_poll=None, backing=None, start_connected=None, allow_guest_control=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Serial.UpdateSpec class describes the updates to be made to the +configuration of a virtual serial port.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • yield_on_poll (bool or None) –

    CPU yield behavior. If set to true, the virtual machine will +periodically relinquish the processor if its sole task is polling +the virtual serial port. The amount of time it takes to regain the +processor will depend on the degree of other virtual machine +activity on the host.

    +

    This attribute may be modified at any time, and changes applied to +a connected virtual serial port take effect immediately. +If None, the value is unchanged.

    +

    • +

  • backing (Serial.BackingSpec or None) –

    Physical resource backing for the virtual serial port.

    +

    This attribute may only be modified if the virtual machine is not +powered on or the virtual serial port is not connected. +If None, the value is unchanged.

    +

    • +

  • start_connected (bool or None) – Flag indicating whether the virtual device should be connected +whenever the virtual machine is powered on. +If None, the value is unchanged.

    • +

  • allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the +device. +If None, the value is unchanged.

    • +
+
+
+
+ +
+
+connect(vm, port)
+

Connects a virtual serial port of a powered-on virtual machine to its +backing. Connecting the virtual device makes the backing accessible +from the perspective of the guest operating system.

+

For a powered-off virtual machine, the Serial.update() method may +be used to configure the virtual serial port to start in the connected +state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual serial port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual serial port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual serial port is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+create(vm, spec)
+

Adds a virtual serial port to the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Serial.CreateSpec) – Specification for the new virtual serial port.

    • +
+
+
Return type
+

str

+
+
Returns
+

Virtual serial port identifier. +The return value will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reported that the serial port device was created but +was unable to confirm the creation because the identifier of the +new device could not be determined.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the virtual machine already has the maximum number of supported +serial ports.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+delete(vm, port)
+

Removes a virtual serial port from the virtual machine.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual serial port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual serial port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+disconnect(vm, port)
+

Disconnects a virtual serial port of a powered-on virtual machine from +its backing. The virtual device is still present and its backing +configuration is unchanged, but from the perspective of the guest +operating system, the serial port is not connected to its backing.

+

For a powered-off virtual machine, the Serial.update() method may +be used to configure the virtual serial port to start in the +disconnected state when the virtual machine is powered on.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual serial port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual serial port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the virtual serial port is already disconnected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+get(vm, port)
+

Returns information about a virtual serial port.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual serial port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

    • +
+
+
Return type
+

Serial.Info

+
+
Returns
+

Information about the specified virtual serial port.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual serial port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+list(vm)
+

Returns commonly used information about the virtual serial ports +belonging to the virtual machine.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

list of Serial.Summary

+
+
Returns
+

List of commonly used information about virtual serial ports.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+
+update(vm, port, spec)
+

Updates the configuration of a virtual serial port.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • port (str) – Virtual serial port identifier. +The parameter must be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.SerialPort.

    • +

  • spec (Serial.UpdateSpec) – Specification for updating the virtual serial port.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine or virtual serial port is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if one or more of the attributes specified in the spec +parameter cannot be modified due to the current power state of the +virtual machine or the connection state of the virtual serial port.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.hardware_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm.storage_client module

+
+
+class com.vmware.vcenter.vm.storage_client.Policy(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Policy class provides methods to configure the storage policies +associated with the virtual machine home and/or its virtual disks. This +class was added in vSphere API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class DiskPolicySpec(type=None, policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.DiskPolicySpec class provides a specification for the +storage policy to be associated with the virtual disks. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Policy.DiskPolicySpec.PolicyType) – Policy type to be used while performing update operation on the +virtual disks. This attribute was added in vSphere API 6.7.

    • +

  • policy (str) – Storage Policy identification. This attribute was added in vSphere +API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy. +This attribute is optional and it is only relevant when the value +of type is +Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY.

    • +
+
+
+
+
+class PolicyType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Policy.DiskPolicySpec class defines the choices for how to specify +the policy to be associated with a virtual disk. This enumeration was added +in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PolicyType instance.

+
+
+
+
+USE_DEFAULT_POLICY = PolicyType(string='USE_DEFAULT_POLICY')
+

Use the default storage policy of the datastore. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+USE_SPECIFIED_POLICY = PolicyType(string='USE_SPECIFIED_POLICY')
+

Use the specified policy (see Policy.DiskPolicySpec.policy). This +class attribute was added in vSphere API 6.7.

+
+ +
+ +
+ +
+
+class Info(vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.Info class contains information about the storage policies +associated with virtual machine’s home directory and virtual hard disks. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_home (str or None) – Storage Policy associated with virtual machine home. This attribute +was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy. +IfNone, the virtual machine’s home directory doesn’t have any +storage policy.

    • +

  • disks (dict of str and str) – Storage policies associated with virtual disks. The values in this +dict are storage policy identifiers. They will be +identifiers for the resource type:com.vmware.vcenter.StoragePolicy +If the dict is empty, the virtual machine does not have +any disks or its disks are not associated with a storage policy. +This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +
+
+
+
+ +
+
+class UpdateSpec(vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.UpdateSpec class describes the updates to be made to the +storage policies associated with the virtual machine home and/or its +virtual disks. This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_home (Policy.VmHomePolicySpec or None) – Storage policy to be used when reconfiguring the virtual machine +home. This attribute was added in vSphere API 6.7. +if None the current storage policy is retained.

    • +

  • disks ((dict of str and Policy.DiskPolicySpec) or None) – Storage policy or policies to be used when reconfiguring virtual +machine diks. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +if None the current storage policy is retained.

    • +
+
+
+
+ +
+
+class VmHomePolicySpec(type=None, policy=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Policy.VmHomePolicySpec class provides a specification for the +storage policy to be associated with the virtual machine home’s directory. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • type (Policy.VmHomePolicySpec.PolicyType) – Policy type to be used while performing update operation on the +virtual machine home’s directory. This attribute was added in +vSphere API 6.7.

    • +

  • policy (str) – Storage Policy identification. This attribute was added in vSphere +API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy. +This attribute is optional and it is only relevant when the value +of type is +Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY.

    • +
+
+
+
+
+class PolicyType(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Policy.VmHomePolicySpec.PolicyType class defines the choices for +how to specify the policy to be associated with the virtual machine home’s +directory. This enumeration was added in vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the PolicyType instance.

+
+
+
+
+USE_DEFAULT_POLICY = PolicyType(string='USE_DEFAULT_POLICY')
+

Use the default storage policy of the datastore. This class attribute was +added in vSphere API 6.7.

+
+ +
+
+USE_SPECIFIED_POLICY = PolicyType(string='USE_SPECIFIED_POLICY')
+

Use the specified policy (see Policy.VmHomePolicySpec.policy). This +class attribute was added in vSphere API 6.7.

+
+ +
+ +
+ +
+
+get(vm)
+

Returns Information about Storage Policy associated with a virtual +machine’s home directory and/or its virtual hard disks. This method was +added in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Virtual machine identifier +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Policy.Info

+
+
Returns
+

Overview of Storage Policy associated with a virtual machine’s home +directory and/or its associated virtual hard disks.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user can not be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required privileges.

+
+
+
+ +
+
+update(vm, spec)
+

Updates the storage policy configuration of a virtual machine and/or +its associated virtual hard disks. This method was added in vSphere API +6.7.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (Policy.UpdateSpec) – Storage Policy Specification for updating the virtual machine and +virtual disks.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user is not authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user doesn’t have the required priveleges.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the storage policy specified is invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine or disk is busy performing another +operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine or disk’s configuration state cannot be +accessed.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.storage_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+

com.vmware.vcenter.vm.tools_client module

+

The com.vmware.vcenter.vm_client module provides classes for managing +VMware Tools.

+
+
+class com.vmware.vcenter.vm.tools_client.Installer(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Installer (\@term service} provides methods to install VMware +Tools in the guest operating system. This class was added in vSphere API +7.0.0.0.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(is_connected=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Installer.Info class contains information about the VMWare Tools +installer. This class was added in vSphere API 7.0.0.0.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

is_connected (bool) – Flag indicating whether the VMware Tools installer is mounted as a +CD-ROM. This attribute was added in vSphere API 7.0.0.0.

+
+
+
+ +
+
+connect(vm)
+

Connects the VMware Tools CD installer as a CD-ROM for the guest +operating system. On Windows guest operating systems with autorun, this +should cause the installer to initiate the Tools installation which +will need user input to complete. On other (non-Windows) guest +operating systems this will make the Tools installation available, and +a a user will need to do guest-specific actions. On Linux, this +includes opening an archive and running the installer. To monitor the +status of the Tools install, clients should check the versionStatus +and runState from com.vmware.vcenter.vm_client.Tools.get(). +This method was added in vSphere API 7.0.0.0.

+
+
Parameters
+

vm (str) – Virtual machine ID +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyInDesiredState +if the VMware Tools CD is already connected.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the Tools installation fails in the guest operating system.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+
+disconnect(vm)
+

Disconnect the VMware Tools installer CD image. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+

vm (str) – Virtual machine ID +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is not powered on.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+
+get(vm)
+

Get information about the VMware Tools installer. This method was added +in vSphere API 7.0.0.0.

+
+
Parameters
+

vm (str) – Identifier of the virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Installer.Info

+
+
Returns
+

information about the VMware Tools installer.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.tools_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.vm.storage.html b/vsphere/8.0.2.0/com.vmware.vcenter.vm.storage.html new file mode 100644 index 00000000..05f13a7a --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.vm.storage.html @@ -0,0 +1,425 @@ + + + + + + + com.vmware.vcenter.vm.storage package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.vm.storage package

+
+

Submodules

+
+
+

com.vmware.vcenter.vm.storage.policy_client module

+
+
+class com.vmware.vcenter.vm.storage.policy_client.Compliance(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Compliance class provides methods that return the compliance status of +virtual machine entities(virtual machine home directory and virtual disks) +that specify storage policy requirements. This class was added in vSphere +API 6.7.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckSpec(vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Compliance.CheckSpec class contains attributes used to specify the +entities on which the storage policy compliance check is to be invoked. +This class was added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • vm_home (bool) – Invoke compliance check on the virtual machine home directory if +set to true. This attribute was added in vSphere API 6.7.

    • +

  • disks (set of str or None) – Identifiers of the virtual machine’s virtual disks for which +compliance should be checked. This attribute was added in vSphere +API 6.7. +When clients pass a value of this class as a parameter, the +attribute must contain identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. When methods return a +value of this class as a return value, the attribute will contain +identifiers for the resource type: +com.vmware.vcenter.vm.hardware.Disk. +If None or empty, compliance check is invoked on all the associated +disks.

    • +
+
+
+
+ +
+
+class Info(overall_compliance=None, vm_home=None, disks=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Compliance.Info class contains information about the storage policy +compliance of a virtual machine, including information about it’s home +directory and/or it’s virtual disks. This class was added in vSphere API +6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • overall_compliance (Compliance.Status) – The overall compliance status of the virtual machine and all it’s +entities. This attribute was added in vSphere API 6.7.

    • +

  • vm_home (Compliance.VmComplianceInfo or None) – The storage policy compliance information +Compliance.VmComplianceInfo for the virtual machine’s home +directory. This attribute was added in vSphere API 6.7. +If None the virtual machine home directory has no storage policy +association.

    • +

  • disks (dict of str and Compliance.VmComplianceInfo) – The compliance information Compliance.VmComplianceInfo for +the virtual machine’s virtual disks that are currently associated +with a storage policy. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the key in +the attribute dict must be an identifier for the resource +type: com.vmware.vcenter.vm.hardware.Disk. When methods return +a value of this class as a return value, the key in the attribute +dict will be an identifier for the resource type: +com.vmware.vcenter.vm.hardware.Disk.

    • +
+
+
+
+ +
+
+class Status(string)
+

Bases: vmware.vapi.bindings.enum.Enum

+

The Compliance.Status class defines the storage compliance status of a +virtual machine and its applicable entities. This enumeration was added in +vSphere API 6.7.

+
+

Note

+

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 enumerated +type description page.

+
+
+
Parameters
+

string (str) – String value for the Status instance.

+
+
+
+
+COMPLIANT = Status(string='COMPLIANT')
+

Entity is in compliance. This class attribute was added in vSphere API 6.7.

+
+ +
+
+NON_COMPLIANT = Status(string='NON_COMPLIANT')
+

Entity is out of compliance. This class attribute was added in vSphere API +6.7.

+
+ +
+
+NOT_APPLICABLE = Status(string='NOT_APPLICABLE')
+

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.

+
+ +
+
+OUT_OF_DATE = Status(string='OUT_OF_DATE')
+

The Compliance status becomes out-of-date when the profile associated with +the entity is edited but not applied. The compliance status remains +out-of-date until the edited policy is applied to the entity. This class +attribute was added in vSphere API 6.7.

+
+ +
+
+UNKNOWN_COMPLIANCE = Status(string='UNKNOWN_COMPLIANCE')
+

Compliance status of the entity is not known. This class attribute was +added in vSphere API 6.7.

+
+ +
+ +
+
+class VmComplianceInfo(status=None, check_time=None, policy=None, failure_cause=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Compliance.VmComplianceInfo class contains information about +storage policy compliance associated with a virtual machine. This class was +added in vSphere API 6.7.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • status (Compliance.Status) – Status of the compliance operation. This attribute was added in +vSphere API 6.7.

    • +

  • check_time (datetime.datetime) – Date and time of the most recent compliance check. This attribute +was added in vSphere API 6.7.

    • +

  • policy (str or None) – Identifier of the storage policy associated with the virtual +machine. This attribute was added in vSphere API 6.7. +When clients pass a value of this class as a parameter, the +attribute must be an identifier for the resource type: +com.vmware.vcenter.StoragePolicy. When methods return a value +of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.vcenter.StoragePolicy. +If None SPBM is unable to retrieve or determine the associated +policy, Compliance.VmComplianceInfo.failure_cause is set in +such casses.

    • +

  • failure_cause (list of com.vmware.vapi.std_client.LocalizableMessage) – The exception that caused the compliance check to fail. There can +be more than one cause, since a policy can contain capabilities +from multiple providers. If empty, it implies no failures while +retrieving compliance. This attribute was added in vSphere API 6.7.

    • +
+
+
+
+ +
+
+check(vm, check_spec=None)
+

Returns the storage policy Compliance Compliance.Info of a +virtual machine after explicitly re-computing compliance check. This +method was added in vSphere API 6.7.

+
+
Parameters
+
    +

  • vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • check_spec (Compliance.CheckSpec or None) – Parameter specifies the entities on which storage policy compliance +check is to be invoked. The storage compliance Info +Compliance.Info is returned. +If None, the behavior is equivalent to a +Compliance.CheckSpec with CheckSpec#vmHome set to true and +CheckSpec#disks populated with all disks attached to the virtual +machine.

    • +
+
+
Return type
+

Compliance.Info or None

+
+
Returns
+

Virtual machine storage policy compliance Compliance.Info class +. +If None, neither the virtual machine home directory nor any of it’s +virtual disks are associated with a storage policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service necessary to +complete the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required privileges.

+
+
+
+ +
+
+get(vm)
+

Returns the cached storage policy compliance information of a virtual +machine. This method was added in vSphere API 6.7.

+
+
Parameters
+

vm (str) – Virtual machine identifier. +The parameter must be an identifier for the resource type: +VirtualMachine.

+
+
Return type
+

Compliance.Info or None

+
+
Returns
+

Virtual machine storage policy compliance Info +Compliance.Info. +If None, neither the virtual machine home directory nor any of it’s +virtual disks are associated with a storage policy.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ServiceUnavailable +if the system is unable to communicate with a service to complete +the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user does not have the required privileges.

+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm.storage.policy_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/com.vmware.vcenter.vm_template.html b/vsphere/8.0.2.0/com.vmware.vcenter.vm_template.html new file mode 100644 index 00000000..cd639566 --- /dev/null +++ b/vsphere/8.0.2.0/com.vmware.vcenter.vm_template.html @@ -0,0 +1,1048 @@ + + + + + + + com.vmware.vcenter.vm_template package — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

com.vmware.vcenter.vm_template package

+
+

Submodules

+
+
+

com.vmware.vcenter.vm_template.library_items_client module

+

The com.vmware.vcenter.vm_template.library_items_client module provides +classes and classes for managing virtual machine template library items. This +includes methods for checking out virtual machine template library items and +querying previous versions of checked in virtual machines.

+
+
+class com.vmware.vcenter.vm_template.library_items_client.CheckOuts(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The CheckOuts class provides methods for managing the checkouts of a +library item containing a virtual machine template. This class provides +operations to check out a library item to update the virtual machine +template, and to check in the library item when the virtual machine changes +are complete. This class was added in vSphere API 6.9.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class CheckInSpec(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckOuts.CheckInSpec class defines the information required to +check in a virtual machine into a library item. This class was added in +vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (str) – Message describing the changes made to the virtual machine. This +attribute was added in vSphere API 6.9.1.

+
+
+
+ +
+
+class CheckOutSpec(name=None, placement=None, powered_on=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckOuts.CheckOutSpec class defines the information required to +check out a library item containing a virtual machine template. This class +was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • name (str or None) – Name of the virtual machine to check out of the library item. This +attribute was added in vSphere API 6.9.1. +This attribute is currently required. In the future, if this +attribute is None, the system will choose a suitable name for the +virtual machine.

    • +

  • placement (CheckOuts.PlacementSpec or None) –

    Information used to place the checked out virtual machine. This +attribute was added in vSphere API 6.9.1. +This attribute is currently required. In the future, if this +attribute is None, the system will place the virtual machine on a +suitable resource.

    +

    If specified, each attribute will be used for placement. If the +attributes result in disjoint placement, the operation will fail. +If the attributes along with the placement values of the source +virtual machine template result in disjoint placement, the +operation will fail.

    +

    • +

  • powered_on (bool or None) – Specifies whether the virtual machine should be powered on after +check out. This attribute was added in vSphere API 6.9.1. +If None, the virtual machine will not be powered on after check +out.

    • +
+
+
+
+ +
+
+class Info(time=None, user=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckOuts.Info class contains information about a checked out +virtual machine. This class was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • time (datetime.datetime) – Date and time when the virtual machine was checked out. This +attribute was added in vSphere API 6.9.1.

    • +

  • user (str) – Name of the user who checked out the virtual machine. This +attribute was added in vSphere API 6.9.1.

    • +
+
+
+
+ +
+
+class PlacementSpec(folder=None, resource_pool=None, host=None, cluster=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckOuts.PlacementSpec class contains information used to place a +checked out virtual machine onto resources within the vCenter inventory. +The specified compute resource should have access to the storage associated +with the checked out virtual machine. This class was added in vSphere API +6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • folder (str or None) – Virtual machine folder into which the virtual machine should be +placed. 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: Folder. +When methods return a value of this class as a return value, the +attribute will be an identifier for the resource type: Folder. +If None, the virtual machine will be placed in the same folder as +the source virtual machine template.

    • +

  • resource_pool (str or None) – Resource pool into which the virtual machine should be placed. 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: +ResourcePool. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: ResourcePool. +If None, the system will attempt to choose a suitable resource pool +for the virtual machine; if a resource pool cannot be chosen, the +operation will fail.

    • +

  • host (str or None) – Host onto which the virtual machine should be placed. If host +and resourcePool are both specified, resourcePool must +belong to host. If host and cluster are both specified, +host must be a member of cluster. 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: +HostSystem. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: HostSystem. +This attribute may be None if resourcePool or cluster is +specified. If None, the system will attempt to choose a suitable +host for the virtual machine; if a host cannot be chosen, the +operation will fail.

    • +

  • cluster (str or None) – Cluster onto which the virtual machine should be placed. If +cluster and resourcePool are both specified, +resourcePool must belong to cluster. If cluster and +host are both specified, host must be a member of +cluster. 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: +ClusterComputeResource. When methods return a value of this +class as a return value, the attribute will be an identifier for +the resource type: ClusterComputeResource. +If resourcePool or host is specified, it is recommended +that this attribute be None.

    • +
+
+
+
+ +
+
+class Summary(vm=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The CheckOuts.Summary class contains commonly used information about a +checked out virtual machine. This class was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

vm (str) – Identifier of the checked out virtual machine. 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: +VirtualMachine. When methods return a value of this class as a +return value, the attribute will be an identifier for the resource +type: VirtualMachine.

+
+
+
+ +
+
+check_in(template_library_item, vm, spec=None)
+

Checks in a virtual machine into the library item. This method updates +the library item to contain the virtual machine being checked in as a +template. This template becomes the latest version of the library item. +The previous virtual machine template contained in the library item is +available as a backup and its information can be queried using the +Versions class. At most one previous version of a virtual machine +template is retained in the library item. This method was added in +vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the content library item in which the virtual machine +is checked in. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • vm (str) – Identifier of the virtual machine to check into the library item. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +

  • spec (CheckOuts.CheckInSpec or None) – Specification used to check in the virtual machine into the library +item. +This parameter is currently required. In the future, if this +parameter is None, the system will apply suitable defaults.

    • +
+
+
Return type
+

str

+
+
Returns
+

The new version of the library item. +The return value will be an identifier for the resource type: +com.vmware.content.library.item.Version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if any of the specified parameters are invalid.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the virtual machine identified by vm was not checked out of +the item specified by template_library_item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the method cannot be performed because of the virtual machine’s +current state. For example, if the virtual machine is not powered +off.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the item specified by template_library_item does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the virtual machine specified by vm does not exist.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there is an error accessing a file from the virtual machine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires +ContentLibrary.CheckInTemplate.

    • +

  • The resource VirtualMachine referenced by the parameter +vm requires System.Read.

    • +
+
+
+
+ +
+
+check_out(template_library_item, spec=None)
+

Checks out a library item containing a virtual machine template. This +method makes a copy of the source virtual machine template contained in +the library item as a virtual machine. The virtual machine is copied +with the same storage specification as the source virtual machine +template. Changes to the checked out virtual machine do not affect the +virtual machine template contained in the library item. To save these +changes back into the library item, CheckOuts.check_in() the +virtual machine. To discard the changes, CheckOuts.delete() the +virtual machine. This method was added in vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the content library item containing the source +virtual machine template to be checked out. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • spec (CheckOuts.CheckOutSpec or None) – Specification used to check out the source virtual machine template +as a virtual machine. +This parameter is currently required. In the future, if this +parameter is None, the system will apply suitable defaults.

    • +
+
+
Return type
+

str

+
+
Returns
+

Identifier of the virtual machine that was checked out of the +library item. +The return value will be an identifier for the resource type: +VirtualMachine.

+
+
Raise
+

com.vmware.vapi.std.errors_client.AlreadyExists +if a virtual machine with the name specified by +CheckOuts.CheckOutSpec.name already exists in the folder +specified by CheckOuts.PlacementSpec.folder.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if spec contains invalid arguments.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item is a member of a subscribed library.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item specified by template_library_item cannot +be found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if there is an error accessing the files of the source virtual +machine template contained in the library item specified by +template_library_item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.UnableToAllocateResource +if the limit for the number of virtual machines checked out of a +library item (currently 1) has been exceeded.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires +ContentLibrary.CheckOutTemplate.

    • +

  • The resource Folder referenced by the attribute +CheckOuts.PlacementSpec.folder requires System.Read.

    • +

  • The resource ResourcePool referenced by the attribute +CheckOuts.PlacementSpec.resource_pool requires +System.Read.

    • +

  • The resource HostSystem referenced by the attribute +CheckOuts.PlacementSpec.host requires System.Read.

    • +

  • The resource ClusterComputeResource referenced by the +attribute CheckOuts.PlacementSpec.cluster requires +System.Read.

    • +
+
+
+
+ +
+
+delete(template_library_item, vm)
+

Deletes the checked out virtual machine. This method was added in +vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • vm (str) – Identifier of the checked out virtual machine to delete. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item or virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the virtual machine is not checked out of the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if the virtual machine is running (powered on).

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceBusy +if the virtual machine is busy performing another operation.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine’s configuration state cannot be accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource VirtualMachine referenced by the parameter +vm requires VirtualMachine.Inventory.Delete.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires System.Read.

    • +
+
+
+
+ +
+
+get(template_library_item, vm)
+

Returns the information about a checked out virtual machine. This +method was added in vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • vm (str) – Identifier of the checked out virtual machine. +The parameter must be an identifier for the resource type: +VirtualMachine.

    • +
+
+
Return type
+

CheckOuts.Info

+
+
Returns
+

Information about a check out.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item or virtual machine is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the virtual machine is not checked out of the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires System.Read.

    • +

  • The resource VirtualMachine referenced by the parameter +vm requires System.Read.

    • +
+
+
+
+ +
+
+list(template_library_item)
+

Returns commonly used information about the virtual machines that are +checked out of the library item. This method was added in vSphere API +6.9.1.

+
+
Parameters
+

template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

list of CheckOuts.Summary

+
+
Returns
+

List of commonly used information about the check outs.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires System.Read.

    • +
+
+
+
+ +
+ +
+
+class com.vmware.vcenter.vm_template.library_items_client.StubFactory(stub_config)
+

Bases: vmware.vapi.bindings.stub.StubFactoryBase

+

Initialize StubFactoryBase

+
+
Parameters
+

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

+
+
+
+ +
+
+class com.vmware.vcenter.vm_template.library_items_client.Versions(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+

The Versions class provides methods for managing the live versions of +the virtual machine templates contained in a library item. Live versions +include the latest and previous virtual machine templates that are +available on disk. As new versions of virtual machine templates are checked +in, old versions of virtual machine templates are automatically purged. +Currently, at most one previous virtual machine template version is stored. +This class was added in vSphere API 6.9.1.

+
+
Parameters
+

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

+
+
+
+
+class Info(vm_template=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Info class contains information about a version of a +library item containing a virtual machine template. This class was added in +vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

vm_template (str) – Identifier of the virtual machine template associated with the +library item version. This attribute is the managed object +identifier used to identify the virtual machine template in the +vSphere Management (SOAP) API. This attribute was added in vSphere +API 6.9.1.

+
+
+
+ +
+
+RESOURCE_TYPE = 'com.vmware.content.library.item.Version'
+

Resource type for library item versions. This class attribute was added in +vSphere API 6.9.1.

+
+ +
+
+class RollbackSpec(message=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.RollbackSpec class defines the information required to +rollback a virtual machine template library item to a previous version. +This class was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+

message (str) – Message describing the reason for the rollback. This attribute was +added in vSphere API 6.9.1.

+
+
+
+ +
+
+class Summary(version=None, vm_template=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+

The Versions.Summary class contains commonly used information about a +version of a library item containing a virtual machine template. This class +was added in vSphere API 6.9.1.

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+
+
Parameters
+
    +

  • version (str) – 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: +com.vmware.content.library.item.Version. When methods return a +value of this class as a return value, the attribute will be an +identifier for the resource type: +com.vmware.content.library.item.Version.

    • +

  • vm_template (str) – Identifier of the virtual machine template associated with the +library item version. This attribute is the managed object +identifier used to identify the virtual machine template in the +vSphere Management (SOAP) API. This attribute was added in vSphere +API 6.9.1.

    • +
+
+
+
+ +
+
+delete(template_library_item, version)
+

Deletes the virtual machine template contained in the library item at +the specified version. This method was added in vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • version (str) – Version of the library item to delete. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.Version.

    • +
+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item or version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified version is the latest version of the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.ResourceInaccessible +if the virtual machine template’s configuration state cannot be +accessed.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires +ContentLibrary.DeleteLibraryItem.

    • +

  • The resource com.vmware.content.library.item.Version +referenced by the parameter version requires System.Read.

    • +
+
+
+
+ +
+
+get(template_library_item, version)
+

Returns information about the live version of a library item containing +a virtual machine template. This method was added in vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • version (str) – Version of the library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.Version.

    • +
+
+
Return type
+

Versions.Info

+
+
Returns
+

Information about the specified library item version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item or version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires System.Read.

    • +

  • The resource com.vmware.content.library.item.Version +referenced by the parameter version requires System.Read.

    • +
+
+
+
+ +
+
+list(template_library_item)
+

Returns commonly used information about the live versions of a virtual +machine template library item. This method was added in vSphere API +6.9.1.

+
+
Parameters
+

template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

+
+
Return type
+

list of Versions.Summary

+
+
Returns
+

List of commonly used information about the library item versions.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires System.Read.

    • +
+
+
+
+ +
+
+rollback(template_library_item, version, spec=None)
+

Rollbacks a library item containing a virtual machine template to a +previous version. The virtual machine template at the specified version +becomes the latest virtual machine template with a new version +identifier. This method was added in vSphere API 6.9.1.

+
+
Parameters
+
    +

  • template_library_item (str) – Identifier of the VM template library item. +The parameter must be an identifier for the resource type: +com.vmware.content.library.Item.

    • +

  • version (str) – Version of the library item to rollback. +The parameter must be an identifier for the resource type: +com.vmware.content.library.item.Version.

    • +

  • spec (Versions.RollbackSpec or None) – Specification to rollback the library item. +This parameter is currently required. In the future, if this +parameter is None, the system will apply suitable defaults.

    • +
+
+
Return type
+

str

+
+
Returns
+

The new version of the library item. +The return value will be an identifier for the resource type: +com.vmware.content.library.item.Version.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotFound +if the library item or version is not found.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the specified version is the latest version of the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.InvalidArgument +if the library item does not contain a virtual machine template.

+
+
Raise
+

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState +if a virtual machine is checked out of the library item.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthenticated +if the user that requested the method cannot be authenticated.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if the user that requested the method is not authorized to perform +the method.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Error +if the system reports an error while responding to the request.

+
+
Raise
+

com.vmware.vapi.std.errors_client.Unauthorized +if you do not have all of the privileges described as follows:

+
    +

  • Method execution requires System.Read.

    • +

  • The resource com.vmware.content.library.Item referenced by +the parameter template_library_item requires +ContentLibrary.CheckInTemplate.

    • +

  • The resource com.vmware.content.library.item.Version +referenced by the parameter version requires System.Read.

    • +
+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/enumeration.html b/vsphere/8.0.2.0/enumeration.html new file mode 100644 index 00000000..0187ede2 --- /dev/null +++ b/vsphere/8.0.2.0/enumeration.html @@ -0,0 +1,181 @@ + + + + + + + Interface definition language to python mapping for enumerated types — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Interface definition language to python mapping for enumerated types
    • +
  • + View page source +
    • +
+
+
+
+
+ +
+

Interface definition language to python mapping for enumerated types

+

The interface language definition type system includes enumerated types. Python +SDK supports both 2.x and 3.x versions of Python. Since Python 2.x does +not have first class support for enumerations, special classes are +generated to represent enumerated types from the interface definition +language. The special class contains class attributes which represent +the values of the enumerated type.

+

This documentation explains the following:

+
    +

  • How the class variables are defined in the module. This specifies the names that you can use in your program.

    • +

  • How you instantiate a class to use it for communication with future versions of the service.

    • +
+
+

Example of an enumerated type documentation

+
+
class com.vmware.vapi.metadata_client. SourceType (string)

Bases: vmware.vapi.bindings.enum.Enum

+

Metadata source type

+
+

Note

+

This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See enumerated type description page.

+
+

Parameters : string (str) – String value for the SourceType instance.

+
+
FILE = SourceType(string=’FILE’)

If the source is backed by a file.

+
+
REMOTE = SourceType(string=’REMOTE’)

If the source is backed by a remote service.

+
+
+
+
+
+
+

Code Examples

+

The enumerated type classes are defined in python modules that your code +imports. You can use these in your code.

+
    +

  1. If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.

    2. +
+
# SourceType is an enumerated type
+from com.vmware.vapi.metadata_client import SourceType
+
+# SourceType has two class attrites, SourceType.FILE and SourceType.REMOTE
+spec = Source.CreateSpec(type=SourceType.FILE, filepath='entity_metadata.json', description='Entity service')
+source_svc.create(id='entity', spec=spec)
+
+
+
    +

  1. When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.

    2. +
+
# SourceType is an enumerated type
+from com.vmware.vapi.metadata_client import SourceType
+
+source_info = source_svc.get(id='entity')
+if (source_info.type == SourceType.FILE) {
+    print 'Source is a file'
+} else if (source_info.type == SourceType.REMOTE) {
+    print 'Source is a remote provider'
+} else {
+    print 'Unknown source type: %s' % str(source_info.type)
+}
+
+
+
    +

  1. Sending a new enumerated type value to a server that has a newer version of the enumerated type.

    2. +
+

To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the +enumerated type class.

+
# If a newer version of SourceType has a new value FOLDER, FOLDER would be one
+# of the class attributes for SourceType. In the older version, SourceType has
+# only two class attributes, FILE and REMOTE
+from com.vmware.vapi.metadata_client import SourceType
+spec = Source.CreateSpec(type=SourceType('FOLDER'), filepath='entity_metadata', description='Entity service')
+source_svc.create(id='entity', spec=spec)
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/genindex.html b/vsphere/8.0.2.0/genindex.html new file mode 100644 index 00000000..cf42b0b2 --- /dev/null +++ b/vsphere/8.0.2.0/genindex.html @@ -0,0 +1,15196 @@ + + + + + + Index — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | J + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | X + | Y + | Z + +
+

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

J

+ + + +
+ +

K

+ + + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

Q

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
+ +

W

+ + + +
+ +

X

+ + + +
+ +

Y

+ + + +
+ +

Z

+ + + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/index.html b/vsphere/8.0.2.0/index.html new file mode 100644 index 00000000..c4365061 --- /dev/null +++ b/vsphere/8.0.2.0/index.html @@ -0,0 +1,659 @@ + + + + + + + Welcome to vSphere Automation SDK for Python.’s documentation! — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Welcome to vSphere Automation SDK for Python.’s documentation!
    • +
  • + View page source +
    • +
+
+
+
+
+ +
+

Welcome to vSphere Automation SDK for Python.’s documentation!

+
+

Contents:

+ +
+
+
+

Indices and tables

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/objects.inv b/vsphere/8.0.2.0/objects.inv new file mode 100644 index 00000000..db106f99 Binary files /dev/null and b/vsphere/8.0.2.0/objects.inv differ diff --git a/vsphere/8.0.2.0/py-modindex.html b/vsphere/8.0.2.0/py-modindex.html new file mode 100644 index 00000000..9f4197f9 --- /dev/null +++ b/vsphere/8.0.2.0/py-modindex.html @@ -0,0 +1,1787 @@ + + + + + + Python Module Index — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Module Index
    • +
  • +
    • +
+
+
+
+
+ + +

Python Module Index

+ +
+ c +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ c
+ com +
    + com.vmware +
    + com.vmware.appliance +
    + com.vmware.appliance.access_client +
    + com.vmware.appliance.health_client +
    + com.vmware.appliance.infraprofile_client +
    + com.vmware.appliance.local_accounts_client +
    + com.vmware.appliance.localaccounts_client +
    + com.vmware.appliance.logging_client +
    + com.vmware.appliance.monitoring_client +
    + com.vmware.appliance.networking +
    + com.vmware.appliance.networking.dns_client +
    + com.vmware.appliance.networking.firewall_client +
    + com.vmware.appliance.networking.interfaces_client +
    + com.vmware.appliance.networking_client +
    + com.vmware.appliance.ntp_client +
    + com.vmware.appliance.recovery +
    + com.vmware.appliance.recovery.backup +
    + com.vmware.appliance.recovery.backup.job_client +
    + com.vmware.appliance.recovery.backup.system_name_client +
    + com.vmware.appliance.recovery.backup_client +
    + com.vmware.appliance.recovery.reconciliation_client +
    + com.vmware.appliance.recovery.restore_client +
    + com.vmware.appliance.recovery_client +
    + com.vmware.appliance.shutdown_client +
    + com.vmware.appliance.support_bundle_client +
    + com.vmware.appliance.supportbundle_client +
    + com.vmware.appliance.system +
    + com.vmware.appliance.system.security_client +
    + com.vmware.appliance.system.time_client +
    + com.vmware.appliance.system_client +
    + com.vmware.appliance.update_client +
    + com.vmware.appliance.vcenter +
    + com.vmware.appliance.vcenter.settings +
    + com.vmware.appliance.vcenter.settings.v1 +
    + com.vmware.appliance.vcenter.settings.v1.config +
    + com.vmware.appliance.vcenter.settings.v1.config.components +
    + com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client +
    + com.vmware.appliance.vcenter.settings.v1.config.components_client +
    + com.vmware.appliance.vcenter.settings.v1.config_client +
    + com.vmware.appliance.vcenter.settings.v1_client +
    + com.vmware.appliance.vmon_client +
    + com.vmware.appliance_client +
    + com.vmware.cis +
    + com.vmware.cis.tagging_client +
    + com.vmware.cis.task_client +
    + com.vmware.cis_client +
    + com.vmware.content +
    + com.vmware.content.library +
    + com.vmware.content.library.item +
    + com.vmware.content.library.item.downloadsession_client +
    + com.vmware.content.library.item.updatesession_client +
    + com.vmware.content.library.item_client +
    + com.vmware.content.library_client +
    + com.vmware.content.type +
    + com.vmware.content.type.ovf +
    + com.vmware.content.type.ovf.policy_client +
    + com.vmware.content.type.ovf_client +
    + com.vmware.content_client +
    + com.vmware.esx +
    + com.vmware.esx.hcl +
    + com.vmware.esx.hcl.hosts_client +
    + com.vmware.esx.hcl_client +
    + com.vmware.esx.hosts +
    + com.vmware.esx.hosts.software_client +
    + com.vmware.esx.hosts_client +
    + com.vmware.esx.settings +
    + com.vmware.esx.settings.clusters +
    + com.vmware.esx.settings.clusters.configuration +
    + com.vmware.esx.settings.clusters.configuration.reports_client +
    + com.vmware.esx.settings.clusters.configuration_client +
    + com.vmware.esx.settings.clusters.enablement +
    + com.vmware.esx.settings.clusters.enablement.configuration_client +
    + com.vmware.esx.settings.clusters.enablement_client +
    + com.vmware.esx.settings.clusters.policies +
    + com.vmware.esx.settings.clusters.policies.apply_client +
    + com.vmware.esx.settings.clusters.policies_client +
    + com.vmware.esx.settings.clusters.software +
    + com.vmware.esx.settings.clusters.software.drafts +
    + com.vmware.esx.settings.clusters.software.drafts.software_client +
    + com.vmware.esx.settings.clusters.software.drafts_client +
    + com.vmware.esx.settings.clusters.software.reports +
    + com.vmware.esx.settings.clusters.software.reports.hardware_compatibility +
    + com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client +
    + com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client +
    + com.vmware.esx.settings.clusters.software.reports_client +
    + com.vmware.esx.settings.clusters.software_client +
    + com.vmware.esx.settings.clusters_client +
    + com.vmware.esx.settings.defaults +
    + com.vmware.esx.settings.defaults.clusters +
    + com.vmware.esx.settings.defaults.clusters.policies +
    + com.vmware.esx.settings.defaults.clusters.policies.apply_client +
    + com.vmware.esx.settings.defaults.clusters.policies_client +
    + com.vmware.esx.settings.defaults.clusters_client +
    + com.vmware.esx.settings.defaults.hosts +
    + com.vmware.esx.settings.defaults.hosts.policies +
    + com.vmware.esx.settings.defaults.hosts.policies.apply_client +
    + com.vmware.esx.settings.defaults.hosts.policies_client +
    + com.vmware.esx.settings.defaults.hosts_client +
    + com.vmware.esx.settings.defaults_client +
    + com.vmware.esx.settings.depot_content +
    + com.vmware.esx.settings.depot_content.add_ons_client +
    + com.vmware.esx.settings.depot_content.base_images_client +
    + com.vmware.esx.settings.depot_content.components_client +
    + com.vmware.esx.settings.depot_content_client +
    + com.vmware.esx.settings.depots +
    + com.vmware.esx.settings.depots.offline_client +
    + com.vmware.esx.settings.depots.online_client +
    + com.vmware.esx.settings.depots.umds_client +
    + com.vmware.esx.settings.depots_client +
    + com.vmware.esx.settings.hardware_support +
    + com.vmware.esx.settings.hardware_support.managers +
    + com.vmware.esx.settings.hardware_support.managers.packages_client +
    + com.vmware.esx.settings.hardware_support.managers_client +
    + com.vmware.esx.settings.hardware_support_client +
    + com.vmware.esx.settings.hosts +
    + com.vmware.esx.settings.hosts.enablement_client +
    + com.vmware.esx.settings.hosts.policies +
    + com.vmware.esx.settings.hosts.policies.apply_client +
    + com.vmware.esx.settings.hosts.policies_client +
    + com.vmware.esx.settings.hosts.software +
    + com.vmware.esx.settings.hosts.software.drafts +
    + com.vmware.esx.settings.hosts.software.drafts.software_client +
    + com.vmware.esx.settings.hosts.software.drafts_client +
    + com.vmware.esx.settings.hosts.software.reports_client +
    + com.vmware.esx.settings.hosts.software_client +
    + com.vmware.esx.settings.hosts_client +
    + com.vmware.esx.settings_client +
    + com.vmware.oauth2 +
    + com.vmware.oauth2.errors_client +
    + com.vmware.oauth2_client +
    + com.vmware.vapi +
    + com.vmware.vapi.metadata +
    + com.vmware.vapi.metadata.authentication +
    + com.vmware.vapi.metadata.authentication.service_client +
    + com.vmware.vapi.metadata.authentication_client +
    + com.vmware.vapi.metadata.cli_client +
    + com.vmware.vapi.metadata.metamodel +
    + com.vmware.vapi.metadata.metamodel.resource_client +
    + com.vmware.vapi.metadata.metamodel.service_client +
    + com.vmware.vapi.metadata.metamodel_client +
    + com.vmware.vapi.metadata.privilege +
    + com.vmware.vapi.metadata.privilege.service_client +
    + com.vmware.vapi.metadata.privilege_client +
    + com.vmware.vapi.metadata_client +
    + com.vmware.vapi.std +
    + com.vmware.vapi.std.errors_client +
    + com.vmware.vapi.std.routing_client +
    + com.vmware.vapi.std_client +
    + com.vmware.vapi_client +
    + com.vmware.vcenter +
    + com.vmware.vcenter.authentication_client +
    + com.vmware.vcenter.authorization +
    + com.vmware.vcenter.authorization.privilege_checks_client +
    + com.vmware.vcenter.authorization_client +
    + com.vmware.vcenter.certificate_management +
    + com.vmware.vcenter.certificate_management.vcenter_client +
    + com.vmware.vcenter.certificate_management_client +
    + com.vmware.vcenter.compute +
    + com.vmware.vcenter.compute.policies +
    + com.vmware.vcenter.compute.policies.capabilities +
    + com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client +
    + com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm +
    + com.vmware.vcenter.compute.policies.capabilities.vm.evacuation +
    + com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm.evacuation_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm.placement +
    + com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm.placement_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client +
    + com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client +
    + com.vmware.vcenter.compute.policies.capabilities_client +
    + com.vmware.vcenter.compute.policies_client +
    + com.vmware.vcenter.compute_client +
    + com.vmware.vcenter.confidential_computing +
    + com.vmware.vcenter.confidential_computing.sgx_client +
    + com.vmware.vcenter.consumption_domains +
    + com.vmware.vcenter.consumption_domains.zone_associations_client +
    + com.vmware.vcenter.consumption_domains.zones +
    + com.vmware.vcenter.consumption_domains.zones.cluster_client +
    + com.vmware.vcenter.consumption_domains_client +
    + com.vmware.vcenter.content +
    + com.vmware.vcenter.content.registries +
    + com.vmware.vcenter.content.registries.harbor_client +
    + com.vmware.vcenter.content.registries_client +
    + com.vmware.vcenter.crypto_manager +
    + com.vmware.vcenter.crypto_manager.hosts +
    + com.vmware.vcenter.crypto_manager.hosts.kms_client +
    + com.vmware.vcenter.crypto_manager.hosts_client +
    + com.vmware.vcenter.crypto_manager.kms_client +
    + com.vmware.vcenter.crypto_manager_client +
    + com.vmware.vcenter.datastore_client +
    + com.vmware.vcenter.deployment +
    + com.vmware.vcenter.deployment.install +
    + com.vmware.vcenter.deployment.install.initial_config +
    + com.vmware.vcenter.deployment.install.initial_config.remote_psc_client +
    + com.vmware.vcenter.deployment.install.psc_client +
    + com.vmware.vcenter.deployment.install_client +
    + com.vmware.vcenter.deployment.migrate_client +
    + com.vmware.vcenter.deployment_client +
    + com.vmware.vcenter.guest_client +
    + com.vmware.vcenter.host +
    + com.vmware.vcenter.host.entropy_client +
    + com.vmware.vcenter.host_client +
    + com.vmware.vcenter.hvc +
    + com.vmware.vcenter.hvc.management_client +
    + com.vmware.vcenter.hvc_client +
    + com.vmware.vcenter.identity +
    + com.vmware.vcenter.identity.broker +
    + com.vmware.vcenter.identity.broker.tenants_client +
    + com.vmware.vcenter.identity.broker_client +
    + com.vmware.vcenter.identity_client +
    + com.vmware.vcenter.inventory_client +
    + com.vmware.vcenter.iso_client +
    + com.vmware.vcenter.lcm +
    + com.vmware.vcenter.lcm.deployment +
    + com.vmware.vcenter.lcm.deployment.common_client +
    + com.vmware.vcenter.lcm.deployment_client +
    + com.vmware.vcenter.lcm.discovery_client +
    + com.vmware.vcenter.lcm.update_client +
    + com.vmware.vcenter.lcm_client +
    + com.vmware.vcenter.namespace_management +
    + com.vmware.vcenter.namespace_management.clusters_client +
    + com.vmware.vcenter.namespace_management.cns_client +
    + com.vmware.vcenter.namespace_management.networks +
    + com.vmware.vcenter.namespace_management.networks.edges_client +
    + com.vmware.vcenter.namespace_management.networks.nsx +
    + com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client +
    + com.vmware.vcenter.namespace_management.networks.nsx.edges_client +
    + com.vmware.vcenter.namespace_management.networks.nsx_client +
    + com.vmware.vcenter.namespace_management.networks.service_client +
    + com.vmware.vcenter.namespace_management.networks_client +
    + com.vmware.vcenter.namespace_management.software_client +
    + com.vmware.vcenter.namespace_management.stats_client +
    + com.vmware.vcenter.namespace_management.storage_client +
    + com.vmware.vcenter.namespace_management.supervisor_services_client +
    + com.vmware.vcenter.namespace_management.supervisors +
    + com.vmware.vcenter.namespace_management.supervisors.identity_client +
    + com.vmware.vcenter.namespace_management.supervisors.networks +
    + com.vmware.vcenter.namespace_management.supervisors.networks.management_client +
    + com.vmware.vcenter.namespace_management.supervisors.networks.workload_client +
    + com.vmware.vcenter.namespace_management.supervisors_client +
    + com.vmware.vcenter.namespace_management_client +
    + com.vmware.vcenter.namespaces +
    + com.vmware.vcenter.namespaces.user_client +
    + com.vmware.vcenter.namespaces_client +
    + com.vmware.vcenter.ovf_client +
    + com.vmware.vcenter.services_client +
    + com.vmware.vcenter.storage +
    + com.vmware.vcenter.storage.policies +
    + com.vmware.vcenter.storage.policies.compliance_client +
    + com.vmware.vcenter.storage.policies_client +
    + com.vmware.vcenter.storage_client +
    + com.vmware.vcenter.system_config +
    + com.vmware.vcenter.system_config.features +
    + com.vmware.vcenter.system_config.features.tech_preview_client +
    + com.vmware.vcenter.system_config_client +
    + com.vmware.vcenter.tagging_client +
    + com.vmware.vcenter.tokenservice_client +
    + com.vmware.vcenter.topology_client +
    + com.vmware.vcenter.trusted_infrastructure +
    + com.vmware.vcenter.trusted_infrastructure.attestation_client +
    + com.vmware.vcenter.trusted_infrastructure.hosts +
    + com.vmware.vcenter.trusted_infrastructure.hosts.hardware +
    + com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client +
    + com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client +
    + com.vmware.vcenter.trusted_infrastructure.hosts_client +
    + com.vmware.vcenter.trusted_infrastructure.kms_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client +
    + com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client +
    + com.vmware.vcenter.trusted_infrastructure.trusted_clusters +
    + com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client +
    + com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client +
    + com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client +
    + com.vmware.vcenter.trusted_infrastructure_client +
    + com.vmware.vcenter.vcha +
    + com.vmware.vcenter.vcha.cluster_client +
    + com.vmware.vcenter.vcha_client +
    + com.vmware.vcenter.vm +
    + com.vmware.vcenter.vm.compute_client +
    + com.vmware.vcenter.vm.console_client +
    + com.vmware.vcenter.vm.data_sets_client +
    + com.vmware.vcenter.vm.guest +
    + com.vmware.vcenter.vm.guest.filesystem_client +
    + com.vmware.vcenter.vm.guest.networking_client +
    + com.vmware.vcenter.vm.guest_client +
    + com.vmware.vcenter.vm.hardware +
    + com.vmware.vcenter.vm.hardware.adapter_client +
    + com.vmware.vcenter.vm.hardware.boot_client +
    + com.vmware.vcenter.vm.hardware_client +
    + com.vmware.vcenter.vm.storage +
    + com.vmware.vcenter.vm.storage.policy_client +
    + com.vmware.vcenter.vm.storage_client +
    + com.vmware.vcenter.vm.tools_client +
    + com.vmware.vcenter.vm_client +
    + com.vmware.vcenter.vm_template +
    + com.vmware.vcenter.vm_template.library_items_client +
    + com.vmware.vcenter.vm_template_client +
    + com.vmware.vcenter_client +
    + com.vmware.vstats_client +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/search.html b/vsphere/8.0.2.0/search.html new file mode 100644 index 00000000..7ac5a003 --- /dev/null +++ b/vsphere/8.0.2.0/search.html @@ -0,0 +1,122 @@ + + + + + + Search — vSphere Automation SDK for Python. 8.0.2.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/vsphere/8.0.2.0/searchindex.js b/vsphere/8.0.2.0/searchindex.js new file mode 100644 index 00000000..1c9d3b72 --- /dev/null +++ b/vsphere/8.0.2.0/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["com","com.vmware","com.vmware.appliance","com.vmware.appliance.networking","com.vmware.appliance.recovery","com.vmware.appliance.recovery.backup","com.vmware.appliance.system","com.vmware.appliance.vcenter","com.vmware.appliance.vcenter.settings","com.vmware.appliance.vcenter.settings.v1","com.vmware.appliance.vcenter.settings.v1.config","com.vmware.appliance.vcenter.settings.v1.config.components","com.vmware.appliance.vcenter.settings.v1.config.components.inventory","com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster","com.vmware.cis","com.vmware.content","com.vmware.content.library","com.vmware.content.library.item","com.vmware.content.type","com.vmware.content.type.ovf","com.vmware.esx","com.vmware.esx.hcl","com.vmware.esx.hosts","com.vmware.esx.settings","com.vmware.esx.settings.clusters","com.vmware.esx.settings.clusters.configuration","com.vmware.esx.settings.clusters.enablement","com.vmware.esx.settings.clusters.policies","com.vmware.esx.settings.clusters.software","com.vmware.esx.settings.clusters.software.drafts","com.vmware.esx.settings.clusters.software.reports","com.vmware.esx.settings.clusters.software.reports.hardware_compatibility","com.vmware.esx.settings.defaults","com.vmware.esx.settings.defaults.clusters","com.vmware.esx.settings.defaults.clusters.policies","com.vmware.esx.settings.defaults.hosts","com.vmware.esx.settings.defaults.hosts.policies","com.vmware.esx.settings.depot_content","com.vmware.esx.settings.depots","com.vmware.esx.settings.hardware_support","com.vmware.esx.settings.hardware_support.managers","com.vmware.esx.settings.hosts","com.vmware.esx.settings.hosts.policies","com.vmware.esx.settings.hosts.software","com.vmware.esx.settings.hosts.software.drafts","com.vmware.oauth2","com.vmware.vapi","com.vmware.vapi.metadata","com.vmware.vapi.metadata.authentication","com.vmware.vapi.metadata.metamodel","com.vmware.vapi.metadata.privilege","com.vmware.vapi.std","com.vmware.vcenter","com.vmware.vcenter.authorization","com.vmware.vcenter.certificate_management","com.vmware.vcenter.compute","com.vmware.vcenter.compute.policies","com.vmware.vcenter.compute.policies.capabilities","com.vmware.vcenter.compute.policies.capabilities.vm","com.vmware.vcenter.compute.policies.capabilities.vm.evacuation","com.vmware.vcenter.compute.policies.capabilities.vm.placement","com.vmware.vcenter.confidential_computing","com.vmware.vcenter.consumption_domains","com.vmware.vcenter.consumption_domains.zones","com.vmware.vcenter.content","com.vmware.vcenter.content.registries","com.vmware.vcenter.crypto_manager","com.vmware.vcenter.crypto_manager.hosts","com.vmware.vcenter.deployment","com.vmware.vcenter.deployment.install","com.vmware.vcenter.deployment.install.initial_config","com.vmware.vcenter.host","com.vmware.vcenter.hvc","com.vmware.vcenter.identity","com.vmware.vcenter.identity.broker","com.vmware.vcenter.lcm","com.vmware.vcenter.lcm.deployment","com.vmware.vcenter.namespace_management","com.vmware.vcenter.namespace_management.networks","com.vmware.vcenter.namespace_management.networks.nsx","com.vmware.vcenter.namespace_management.supervisors","com.vmware.vcenter.namespace_management.supervisors.networks","com.vmware.vcenter.namespaces","com.vmware.vcenter.storage","com.vmware.vcenter.storage.policies","com.vmware.vcenter.system_config","com.vmware.vcenter.system_config.features","com.vmware.vcenter.trusted_infrastructure","com.vmware.vcenter.trusted_infrastructure.hosts","com.vmware.vcenter.trusted_infrastructure.hosts.hardware","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers","com.vmware.vcenter.trusted_infrastructure.trusted_clusters","com.vmware.vcenter.vcha","com.vmware.vcenter.vm","com.vmware.vcenter.vm.guest","com.vmware.vcenter.vm.hardware","com.vmware.vcenter.vm.storage","com.vmware.vcenter.vm_template","enumeration","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["com.rst","com.vmware.rst","com.vmware.appliance.rst","com.vmware.appliance.networking.rst","com.vmware.appliance.recovery.rst","com.vmware.appliance.recovery.backup.rst","com.vmware.appliance.system.rst","com.vmware.appliance.vcenter.rst","com.vmware.appliance.vcenter.settings.rst","com.vmware.appliance.vcenter.settings.v1.rst","com.vmware.appliance.vcenter.settings.v1.config.rst","com.vmware.appliance.vcenter.settings.v1.config.components.rst","com.vmware.appliance.vcenter.settings.v1.config.components.inventory.rst","com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.rst","com.vmware.cis.rst","com.vmware.content.rst","com.vmware.content.library.rst","com.vmware.content.library.item.rst","com.vmware.content.type.rst","com.vmware.content.type.ovf.rst","com.vmware.esx.rst","com.vmware.esx.hcl.rst","com.vmware.esx.hosts.rst","com.vmware.esx.settings.rst","com.vmware.esx.settings.clusters.rst","com.vmware.esx.settings.clusters.configuration.rst","com.vmware.esx.settings.clusters.enablement.rst","com.vmware.esx.settings.clusters.policies.rst","com.vmware.esx.settings.clusters.software.rst","com.vmware.esx.settings.clusters.software.drafts.rst","com.vmware.esx.settings.clusters.software.reports.rst","com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.rst","com.vmware.esx.settings.defaults.rst","com.vmware.esx.settings.defaults.clusters.rst","com.vmware.esx.settings.defaults.clusters.policies.rst","com.vmware.esx.settings.defaults.hosts.rst","com.vmware.esx.settings.defaults.hosts.policies.rst","com.vmware.esx.settings.depot_content.rst","com.vmware.esx.settings.depots.rst","com.vmware.esx.settings.hardware_support.rst","com.vmware.esx.settings.hardware_support.managers.rst","com.vmware.esx.settings.hosts.rst","com.vmware.esx.settings.hosts.policies.rst","com.vmware.esx.settings.hosts.software.rst","com.vmware.esx.settings.hosts.software.drafts.rst","com.vmware.oauth2.rst","com.vmware.vapi.rst","com.vmware.vapi.metadata.rst","com.vmware.vapi.metadata.authentication.rst","com.vmware.vapi.metadata.metamodel.rst","com.vmware.vapi.metadata.privilege.rst","com.vmware.vapi.std.rst","com.vmware.vcenter.rst","com.vmware.vcenter.authorization.rst","com.vmware.vcenter.certificate_management.rst","com.vmware.vcenter.compute.rst","com.vmware.vcenter.compute.policies.rst","com.vmware.vcenter.compute.policies.capabilities.rst","com.vmware.vcenter.compute.policies.capabilities.vm.rst","com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.rst","com.vmware.vcenter.compute.policies.capabilities.vm.placement.rst","com.vmware.vcenter.confidential_computing.rst","com.vmware.vcenter.consumption_domains.rst","com.vmware.vcenter.consumption_domains.zones.rst","com.vmware.vcenter.content.rst","com.vmware.vcenter.content.registries.rst","com.vmware.vcenter.crypto_manager.rst","com.vmware.vcenter.crypto_manager.hosts.rst","com.vmware.vcenter.deployment.rst","com.vmware.vcenter.deployment.install.rst","com.vmware.vcenter.deployment.install.initial_config.rst","com.vmware.vcenter.host.rst","com.vmware.vcenter.hvc.rst","com.vmware.vcenter.identity.rst","com.vmware.vcenter.identity.broker.rst","com.vmware.vcenter.lcm.rst","com.vmware.vcenter.lcm.deployment.rst","com.vmware.vcenter.namespace_management.rst","com.vmware.vcenter.namespace_management.networks.rst","com.vmware.vcenter.namespace_management.networks.nsx.rst","com.vmware.vcenter.namespace_management.supervisors.rst","com.vmware.vcenter.namespace_management.supervisors.networks.rst","com.vmware.vcenter.namespaces.rst","com.vmware.vcenter.storage.rst","com.vmware.vcenter.storage.policies.rst","com.vmware.vcenter.system_config.rst","com.vmware.vcenter.system_config.features.rst","com.vmware.vcenter.trusted_infrastructure.rst","com.vmware.vcenter.trusted_infrastructure.hosts.rst","com.vmware.vcenter.trusted_infrastructure.hosts.hardware.rst","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.rst","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.rst","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.rst","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.rst","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.rst","com.vmware.vcenter.trusted_infrastructure.trusted_clusters.rst","com.vmware.vcenter.vcha.rst","com.vmware.vcenter.vm.rst","com.vmware.vcenter.vm.guest.rst","com.vmware.vcenter.vm.hardware.rst","com.vmware.vcenter.vm.storage.rst","com.vmware.vcenter.vm_template.rst","enumeration.rst","index.rst"],objects:{"":{com:[0,0,0,"-"]},"com.vmware":{appliance:[2,0,0,"-"],appliance_client:[1,0,0,"-"],cis:[14,0,0,"-"],cis_client:[1,0,0,"-"],content:[15,0,0,"-"],content_client:[1,0,0,"-"],esx:[20,0,0,"-"],oauth2:[45,0,0,"-"],oauth2_client:[1,0,0,"-"],vapi:[46,0,0,"-"],vapi_client:[1,0,0,"-"],vcenter:[52,0,0,"-"],vcenter_client:[1,0,0,"-"],vstats_client:[1,0,0,"-"]},"com.vmware.appliance":{access_client:[2,0,0,"-"],health_client:[2,0,0,"-"],infraprofile_client:[2,0,0,"-"],local_accounts_client:[2,0,0,"-"],localaccounts_client:[2,0,0,"-"],logging_client:[2,0,0,"-"],monitoring_client:[2,0,0,"-"],networking:[3,0,0,"-"],networking_client:[2,0,0,"-"],ntp_client:[2,0,0,"-"],recovery:[4,0,0,"-"],recovery_client:[2,0,0,"-"],shutdown_client:[2,0,0,"-"],support_bundle_client:[2,0,0,"-"],supportbundle_client:[2,0,0,"-"],system:[6,0,0,"-"],system_client:[2,0,0,"-"],update_client:[2,0,0,"-"],vcenter:[7,0,0,"-"],vmon_client:[2,0,0,"-"]},"com.vmware.appliance.access_client":{Consolecli:[2,1,1,""],Dcui:[2,1,1,""],Shell:[2,1,1,""],Ssh:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.access_client.Consolecli":{get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.access_client.Dcui":{get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.access_client.Shell":{ShellConfig:[2,1,1,""],get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.access_client.Ssh":{get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.health_client":{Applmgmt:[2,1,1,""],Database:[2,1,1,""],Databasestorage:[2,1,1,""],Load:[2,1,1,""],Mem:[2,1,1,""],Softwarepackages:[2,1,1,""],Storage:[2,1,1,""],StubFactory:[2,1,1,""],Swap:[2,1,1,""],System:[2,1,1,""]},"com.vmware.appliance.health_client.Applmgmt":{get:[2,2,1,""]},"com.vmware.appliance.health_client.Database":{Info:[2,1,1,""],Message:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Database.Info":{Status:[2,1,1,""]},"com.vmware.appliance.health_client.Database.Info.Status":{DEGRADED:[2,3,1,""],HEALTHY:[2,3,1,""],UNHEALTHY:[2,3,1,""]},"com.vmware.appliance.health_client.Database.Message":{Severity:[2,1,1,""]},"com.vmware.appliance.health_client.Database.Message.Severity":{ERROR:[2,3,1,""],WARNING:[2,3,1,""]},"com.vmware.appliance.health_client.Databasestorage":{HealthLevel:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Databasestorage.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.health_client.Load":{HealthLevel:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Load.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.health_client.Mem":{HealthLevel:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Mem.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.health_client.Softwarepackages":{HealthLevel:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Softwarepackages.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.health_client.Storage":{HealthLevel:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Storage.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.health_client.Swap":{HealthLevel:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.health_client.Swap.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.health_client.System":{HealthLevel:[2,1,1,""],get:[2,2,1,""],lastcheck:[2,2,1,""]},"com.vmware.appliance.health_client.System.HealthLevel":{gray:[2,3,1,""],green:[2,3,1,""],orange:[2,3,1,""],red:[2,3,1,""],yellow:[2,3,1,""]},"com.vmware.appliance.infraprofile_client":{Configs:[2,1,1,""],Notification:[2,1,1,""],Notifications:[2,1,1,""],StubFactory:[2,1,1,""],TaskInfo:[2,1,1,""]},"com.vmware.appliance.infraprofile_client.Configs":{"export":[2,2,1,""],ImportProfileSpec:[2,1,1,""],ProfileInfo:[2,1,1,""],ProfilesSpec:[2,1,1,""],ValidationResult:[2,1,1,""],ValidationStatus:[2,1,1,""],import_profile_task:[2,2,1,""],list:[2,2,1,""],validate_task:[2,2,1,""]},"com.vmware.appliance.infraprofile_client.Configs.ValidationStatus":{INVALID:[2,3,1,""],VALID:[2,3,1,""]},"com.vmware.appliance.local_accounts_client":{Policy:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.local_accounts_client.Policy":{Info:[2,1,1,""],get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.localaccounts_client":{StubFactory:[2,1,1,""]},"com.vmware.appliance.logging_client":{Forwarding:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.logging_client.Forwarding":{Config:[2,1,1,""],ConnectionStatus:[2,1,1,""],Protocol:[2,1,1,""],get:[2,2,1,""],set:[2,2,1,""],test:[2,2,1,""]},"com.vmware.appliance.logging_client.Forwarding.ConnectionStatus":{State:[2,1,1,""]},"com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State":{DOWN:[2,3,1,""],UNKNOWN:[2,3,1,""],UP:[2,3,1,""]},"com.vmware.appliance.logging_client.Forwarding.Protocol":{TCP:[2,3,1,""],TLS:[2,3,1,""],UDP:[2,3,1,""]},"com.vmware.appliance.monitoring_client":{StubFactory:[2,1,1,""]},"com.vmware.appliance.networking":{dns_client:[3,0,0,"-"],firewall_client:[3,0,0,"-"],interfaces_client:[3,0,0,"-"]},"com.vmware.appliance.networking.dns_client":{Domains:[3,1,1,""],Hostname:[3,1,1,""],Servers:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.appliance.networking.dns_client.Domains":{add:[3,2,1,""],list:[3,2,1,""],set:[3,2,1,""]},"com.vmware.appliance.networking.dns_client.Hostname":{Message:[3,1,1,""],MessageStatus:[3,1,1,""],TestStatus:[3,1,1,""],TestStatusInfo:[3,1,1,""],get:[3,2,1,""],set:[3,2,1,""],test:[3,2,1,""]},"com.vmware.appliance.networking.dns_client.Hostname.MessageStatus":{failure:[3,3,1,""],success:[3,3,1,""]},"com.vmware.appliance.networking.dns_client.Hostname.TestStatus":{green:[3,3,1,""],orange:[3,3,1,""],red:[3,3,1,""]},"com.vmware.appliance.networking.dns_client.Servers":{DNSServerConfig:[3,1,1,""],DNSServerMode:[3,1,1,""],Message:[3,1,1,""],MessageStatus:[3,1,1,""],TestStatus:[3,1,1,""],TestStatusInfo:[3,1,1,""],add:[3,2,1,""],get:[3,2,1,""],set:[3,2,1,""],test:[3,2,1,""]},"com.vmware.appliance.networking.dns_client.Servers.DNSServerMode":{dhcp:[3,3,1,""],is_static:[3,3,1,""]},"com.vmware.appliance.networking.dns_client.Servers.MessageStatus":{failure:[3,3,1,""],success:[3,3,1,""]},"com.vmware.appliance.networking.dns_client.Servers.TestStatus":{green:[3,3,1,""],orange:[3,3,1,""],red:[3,3,1,""]},"com.vmware.appliance.networking.firewall_client":{Inbound:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.appliance.networking.firewall_client.Inbound":{Policy:[3,1,1,""],Rule:[3,1,1,""],get:[3,2,1,""],set:[3,2,1,""]},"com.vmware.appliance.networking.firewall_client.Inbound.Policy":{ACCEPT:[3,3,1,""],IGNORE:[3,3,1,""],REJECT:[3,3,1,""],RETURN:[3,3,1,""]},"com.vmware.appliance.networking.interfaces_client":{Ipv4:[3,1,1,""],Ipv6:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.appliance.networking.interfaces_client.Ipv4":{Config:[3,1,1,""],Info:[3,1,1,""],Mode:[3,1,1,""],get:[3,2,1,""],set:[3,2,1,""]},"com.vmware.appliance.networking.interfaces_client.Ipv4.Mode":{DHCP:[3,3,1,""],STATIC:[3,3,1,""],UNCONFIGURED:[3,3,1,""]},"com.vmware.appliance.networking.interfaces_client.Ipv6":{Address:[3,1,1,""],AddressInfo:[3,1,1,""],Config:[3,1,1,""],Info:[3,1,1,""],Origin:[3,1,1,""],Status:[3,1,1,""],get:[3,2,1,""],set:[3,2,1,""]},"com.vmware.appliance.networking.interfaces_client.Ipv6.Origin":{DHCP:[3,3,1,""],LINKLAYER:[3,3,1,""],MANUAL:[3,3,1,""],OTHER:[3,3,1,""],RANDOM:[3,3,1,""]},"com.vmware.appliance.networking.interfaces_client.Ipv6.Status":{DEPRECATED:[3,3,1,""],DUPLICATE:[3,3,1,""],INACCESSIBLE:[3,3,1,""],INVALID:[3,3,1,""],OPTIMISTIC:[3,3,1,""],PREFERRED:[3,3,1,""],TENTATIVE:[3,3,1,""],UNKNOWN:[3,3,1,""]},"com.vmware.appliance.networking_client":{Interfaces:[2,1,1,""],NoProxy:[2,1,1,""],Proxy:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.networking_client.Interfaces":{InterfaceInfo:[2,1,1,""],InterfaceStatus:[2,1,1,""],get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.appliance.networking_client.Interfaces.InterfaceStatus":{down:[2,3,1,""],up:[2,3,1,""]},"com.vmware.appliance.networking_client.NoProxy":{get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.networking_client.Proxy":{"delete":[2,2,1,""],Config:[2,1,1,""],Protocol:[2,1,1,""],ServerStatus:[2,1,1,""],TestResult:[2,1,1,""],get:[2,2,1,""],list:[2,2,1,""],set:[2,2,1,""],test:[2,2,1,""]},"com.vmware.appliance.networking_client.Proxy.Protocol":{FTP:[2,3,1,""],HTTP:[2,3,1,""],HTTPS:[2,3,1,""]},"com.vmware.appliance.networking_client.Proxy.ServerStatus":{SERVER_REACHABLE:[2,3,1,""],SERVER_UNREACHABLE:[2,3,1,""]},"com.vmware.appliance.ntp_client":{StubFactory:[2,1,1,""]},"com.vmware.appliance.recovery":{backup:[5,0,0,"-"],backup_client:[4,0,0,"-"],reconciliation_client:[4,0,0,"-"],restore_client:[4,0,0,"-"]},"com.vmware.appliance.recovery.backup":{job_client:[5,0,0,"-"],system_name_client:[5,0,0,"-"]},"com.vmware.appliance.recovery.backup.job_client":{Details:[5,1,1,""],StubFactory:[5,1,1,""]},"com.vmware.appliance.recovery.backup.job_client.Details":{BuildInfo:[5,1,1,""],FilterSpec:[5,1,1,""],Info:[5,1,1,""],Type:[5,1,1,""],list:[5,2,1,""]},"com.vmware.appliance.recovery.backup.job_client.Details.Type":{MANUAL:[5,3,1,""],SCHEDULED:[5,3,1,""]},"com.vmware.appliance.recovery.backup.system_name_client":{Archive:[5,1,1,""],StubFactory:[5,1,1,""]},"com.vmware.appliance.recovery.backup.system_name_client.Archive":{FilterSpec:[5,1,1,""],Info:[5,1,1,""],Summary:[5,1,1,""],get:[5,2,1,""],list:[5,2,1,""]},"com.vmware.appliance.recovery.backup_client":{Job:[4,1,1,""],LocationSpec:[4,1,1,""],Parts:[4,1,1,""],Schedules:[4,1,1,""],StubFactory:[4,1,1,""],SystemName:[4,1,1,""]},"com.vmware.appliance.recovery.backup_client.Job":{BackupJobStatus:[4,1,1,""],BackupRequest:[4,1,1,""],BackupRestoreProcessState:[4,1,1,""],LocalizableMessage:[4,1,1,""],LocationType:[4,1,1,""],ReturnResult:[4,1,1,""],ReturnStatus:[4,1,1,""],cancel:[4,2,1,""],create:[4,2,1,""],get:[4,2,1,""],list:[4,2,1,""]},"com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState":{FAILED:[4,3,1,""],INPROGRESS:[4,3,1,""],NONE:[4,3,1,""],SUCCEEDED:[4,3,1,""]},"com.vmware.appliance.recovery.backup_client.Job.LocationType":{FTP:[4,3,1,""],FTPS:[4,3,1,""],HTTP:[4,3,1,""],HTTPS:[4,3,1,""],NFS:[4,3,1,""],SCP:[4,3,1,""],SFTP:[4,3,1,""],SMB:[4,3,1,""]},"com.vmware.appliance.recovery.backup_client.Job.ReturnStatus":{FAIL:[4,3,1,""],OK:[4,3,1,""],WARNING:[4,3,1,""]},"com.vmware.appliance.recovery.backup_client.Parts":{LocalizableMessage:[4,1,1,""],Part:[4,1,1,""],get:[4,2,1,""],list:[4,2,1,""]},"com.vmware.appliance.recovery.backup_client.Schedules":{"delete":[4,2,1,""],CreateSpec:[4,1,1,""],DayOfWeek:[4,1,1,""],Info:[4,1,1,""],RecurrenceInfo:[4,1,1,""],RetentionInfo:[4,1,1,""],UpdateSpec:[4,1,1,""],create:[4,2,1,""],get:[4,2,1,""],list:[4,2,1,""],run:[4,2,1,""],update:[4,2,1,""]},"com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek":{FRIDAY:[4,3,1,""],MONDAY:[4,3,1,""],SATURDAY:[4,3,1,""],SUNDAY:[4,3,1,""],THURSDAY:[4,3,1,""],TUESDAY:[4,3,1,""],WEDNESDAY:[4,3,1,""]},"com.vmware.appliance.recovery.backup_client.SystemName":{list:[4,2,1,""]},"com.vmware.appliance.recovery.reconciliation_client":{Job:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.appliance.recovery.reconciliation_client.Job":{CreateSpec:[4,1,1,""],Info:[4,1,1,""],Status:[4,1,1,""],create:[4,2,1,""],get:[4,2,1,""]},"com.vmware.appliance.recovery.reconciliation_client.Job.Status":{FAILED:[4,3,1,""],NONE:[4,3,1,""],RUNNING:[4,3,1,""],SUCCEEDED:[4,3,1,""]},"com.vmware.appliance.recovery.restore_client":{Job:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.appliance.recovery.restore_client.Job":{BackupRestoreProcessState:[4,1,1,""],LocalizableMessage:[4,1,1,""],LocationType:[4,1,1,""],RestoreJobStatus:[4,1,1,""],RestoreRequest:[4,1,1,""],ReturnResult:[4,1,1,""],ReturnStatus:[4,1,1,""],cancel:[4,2,1,""],create:[4,2,1,""],get:[4,2,1,""]},"com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState":{FAILED:[4,3,1,""],INPROGRESS:[4,3,1,""],NONE:[4,3,1,""],SUCCEEDED:[4,3,1,""]},"com.vmware.appliance.recovery.restore_client.Job.LocationType":{FTP:[4,3,1,""],FTPS:[4,3,1,""],HTTP:[4,3,1,""],HTTPS:[4,3,1,""],NFS:[4,3,1,""],SCP:[4,3,1,""],SFTP:[4,3,1,""],SMB:[4,3,1,""]},"com.vmware.appliance.recovery.restore_client.Job.ReturnStatus":{FAIL:[4,3,1,""],OK:[4,3,1,""],WARNING:[4,3,1,""]},"com.vmware.appliance.recovery_client":{Backup:[2,1,1,""],Restore:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.recovery_client.Backup":{BackupRequest:[2,1,1,""],LocalizableMessage:[2,1,1,""],LocationType:[2,1,1,""],ReturnResult:[2,1,1,""],ReturnStatus:[2,1,1,""],validate:[2,2,1,""]},"com.vmware.appliance.recovery_client.Backup.LocationType":{FTP:[2,3,1,""],FTPS:[2,3,1,""],HTTP:[2,3,1,""],HTTPS:[2,3,1,""],NFS:[2,3,1,""],SCP:[2,3,1,""],SFTP:[2,3,1,""],SMB:[2,3,1,""]},"com.vmware.appliance.recovery_client.Backup.ReturnStatus":{FAIL:[2,3,1,""],OK:[2,3,1,""],WARNING:[2,3,1,""]},"com.vmware.appliance.recovery_client.Restore":{LocalizableMessage:[2,1,1,""],LocationType:[2,1,1,""],Metadata:[2,1,1,""],RestoreRequest:[2,1,1,""],validate:[2,2,1,""]},"com.vmware.appliance.recovery_client.Restore.LocationType":{FTP:[2,3,1,""],FTPS:[2,3,1,""],HTTP:[2,3,1,""],HTTPS:[2,3,1,""],NFS:[2,3,1,""],SCP:[2,3,1,""],SFTP:[2,3,1,""],SMB:[2,3,1,""]},"com.vmware.appliance.shutdown_client":{StubFactory:[2,1,1,""]},"com.vmware.appliance.support_bundle_client":{Components:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.support_bundle_client.Components":{get:[2,2,1,""]},"com.vmware.appliance.supportbundle_client":{StubFactory:[2,1,1,""]},"com.vmware.appliance.system":{security_client:[6,0,0,"-"],time_client:[6,0,0,"-"]},"com.vmware.appliance.system.security_client":{GlobalFips:[6,1,1,""],StubFactory:[6,1,1,""]},"com.vmware.appliance.system.security_client.GlobalFips":{Info:[6,1,1,""],UpdateSpec:[6,1,1,""],get:[6,2,1,""],update:[6,2,1,""]},"com.vmware.appliance.system.time_client":{StubFactory:[6,1,1,""],Timezone:[6,1,1,""]},"com.vmware.appliance.system.time_client.Timezone":{get:[6,2,1,""],set:[6,2,1,""]},"com.vmware.appliance.system_client":{Storage:[2,1,1,""],StubFactory:[2,1,1,""],Time:[2,1,1,""],Uptime:[2,1,1,""],Version:[2,1,1,""]},"com.vmware.appliance.system_client.Storage":{StorageChange:[2,1,1,""],StorageMapping:[2,1,1,""],list:[2,2,1,""],resize:[2,2,1,""],resize_ex:[2,2,1,""]},"com.vmware.appliance.system_client.Time":{SystemTimeStruct:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.system_client.Uptime":{get:[2,2,1,""]},"com.vmware.appliance.system_client.Version":{VersionStruct:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.update_client":{CommonInfo:[2,1,1,""],Pending:[2,1,1,""],Policy:[2,1,1,""],ServiceInfo:[2,1,1,""],Staged:[2,1,1,""],StubFactory:[2,1,1,""],Summary:[2,1,1,""]},"com.vmware.appliance.update_client.CommonInfo":{Category:[2,1,1,""],Priority:[2,1,1,""],Severity:[2,1,1,""]},"com.vmware.appliance.update_client.CommonInfo.Category":{FIX:[2,3,1,""],SECURITY:[2,3,1,""],UPDATE:[2,3,1,""],UPGRADE:[2,3,1,""]},"com.vmware.appliance.update_client.CommonInfo.Priority":{HIGH:[2,3,1,""],LOW:[2,3,1,""],MEDIUM:[2,3,1,""]},"com.vmware.appliance.update_client.CommonInfo.Severity":{CRITICAL:[2,3,1,""],IMPORTANT:[2,3,1,""],LOW:[2,3,1,""],MODERATE:[2,3,1,""]},"com.vmware.appliance.update_client.Pending":{Info:[2,1,1,""],PrecheckResult:[2,1,1,""],Question:[2,1,1,""],SourceType:[2,1,1,""],get:[2,2,1,""],install:[2,2,1,""],list:[2,2,1,""],precheck:[2,2,1,""],rollback:[2,2,1,""],stage:[2,2,1,""],stage_and_install:[2,2,1,""],validate:[2,2,1,""]},"com.vmware.appliance.update_client.Pending.Question":{InputType:[2,1,1,""]},"com.vmware.appliance.update_client.Pending.Question.InputType":{BOOLEAN:[2,3,1,""],PASSWORD:[2,3,1,""],PLAIN_TEXT:[2,3,1,""]},"com.vmware.appliance.update_client.Pending.SourceType":{LAST_CHECK:[2,3,1,""],LOCAL:[2,3,1,""],LOCAL_AND_ONLINE:[2,3,1,""]},"com.vmware.appliance.update_client.Policy":{Config:[2,1,1,""],DayOfWeek:[2,1,1,""],Info:[2,1,1,""],Time:[2,1,1,""],get:[2,2,1,""],set:[2,2,1,""]},"com.vmware.appliance.update_client.Policy.DayOfWeek":{FRIDAY:[2,3,1,""],MONDAY:[2,3,1,""],SATURDAY:[2,3,1,""],SUNDAY:[2,3,1,""],THURSDAY:[2,3,1,""],TUESDAY:[2,3,1,""],WEDNESDAY:[2,3,1,""]},"com.vmware.appliance.update_client.Staged":{"delete":[2,2,1,""],Info:[2,1,1,""],get:[2,2,1,""]},"com.vmware.appliance.vcenter":{settings:[8,0,0,"-"]},"com.vmware.appliance.vcenter.settings":{v1:[9,0,0,"-"],v1_client:[8,0,0,"-"]},"com.vmware.appliance.vcenter.settings.v1":{config:[10,0,0,"-"],config_client:[9,0,0,"-"]},"com.vmware.appliance.vcenter.settings.v1.config":{components:[11,0,0,"-"],components_client:[10,0,0,"-"]},"com.vmware.appliance.vcenter.settings.v1.config.components":{applmgmt_client:[11,0,0,"-"],authcommon_client:[11,0,0,"-"],authmanagement_client:[11,0,0,"-"],inventory:[12,0,0,"-"],inventory_client:[11,0,0,"-"],inventoryauthorization_client:[11,0,0,"-"],managementcluster_client:[11,0,0,"-"],vsphereuiconfiguration_client:[11,0,0,"-"]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client":{AccessSettings:[11,1,1,""],Address:[11,1,1,""],ApplianceManagement:[11,1,1,""],ApplianceNetwork:[11,1,1,""],BackupSchedule:[11,1,1,""],Ceip:[11,1,1,""],Consolecli:[11,1,1,""],DatetimeConfig:[11,1,1,""],Dcui:[11,1,1,""],DnsServerConfiguration:[11,1,1,""],FirewallRulePolicy:[11,1,1,""],Interface:[11,1,1,""],Ipv4:[11,1,1,""],Ipv6:[11,1,1,""],LocalAccounts:[11,1,1,""],LocalAccountsPolicy:[11,1,1,""],LogForwarding:[11,1,1,""],Ntp:[11,1,1,""],ProxyConfiguration:[11,1,1,""],RecurrenceInfo:[11,1,1,""],RetentionInfo:[11,1,1,""],Shell:[11,1,1,""],Smtp:[11,1,1,""],SoftwareUpdatePolicy:[11,1,1,""],Ssh:[11,1,1,""],StubFactory:[11,1,1,""],Time:[11,1,1,""],Timesync:[11,1,1,""],Timezone:[11,1,1,""],UserAccountSettings:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address":{Origin:[11,1,1,""],Status:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin":{DHCP:[11,3,1,""],LINKLAYER:[11,3,1,""],MANUAL:[11,3,1,""],OTHER:[11,3,1,""],RANDOM:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status":{DEPRECATED:[11,3,1,""],DUPLICATE:[11,3,1,""],INACCESSIBLE:[11,3,1,""],INVALID:[11,3,1,""],OPTIMISTIC:[11,3,1,""],PREFERRED:[11,3,1,""],TENTATIVE:[11,3,1,""],UNKNOWN:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration":{DNSServerMode:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode":{DHCP:[11,3,1,""],IS_STATIC:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy":{Policy:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy":{ACCEPT:[11,3,1,""],IGNORE:[11,3,1,""],REJECT:[11,3,1,""],RETURN:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface":{InterfaceStatus:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus":{DOWN:[11,3,1,""],UP:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4":{Mode:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode":{DHCP:[11,3,1,""],STATIC:[11,3,1,""],UNCONFIGURED:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding":{Protocol:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol":{RELP:[11,3,1,""],TCP:[11,3,1,""],TLS:[11,3,1,""],UDP:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration":{Protocol:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol":{FTP:[11,3,1,""],HTTP:[11,3,1,""],HTTPS:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo":{DayOfWeek:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek":{FRIDAY:[11,3,1,""],MONDAY:[11,3,1,""],SATURDAY:[11,3,1,""],SUNDAY:[11,3,1,""],THURSDAY:[11,3,1,""],TUESDAY:[11,3,1,""],WEDNESDAY:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy":{AutoUpdateNotification:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification":{DISABLED:[11,3,1,""],ENABLED:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time":{UpdateDay:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay":{EVERYDAY:[11,3,1,""],FRIDAY:[11,3,1,""],MONDAY:[11,3,1,""],SATURDAY:[11,3,1,""],SUNDAY:[11,3,1,""],THURSDAY:[11,3,1,""],TUESDAY:[11,3,1,""],WEDNESDAY:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync":{TimeSyncMode:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode":{DISABLED:[11,3,1,""],HOST:[11,3,1,""],NTP:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client":{Principal:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client":{AuthenticationManagement:[11,1,1,""],GlobalPermission:[11,1,1,""],IdentitySource:[11,1,1,""],IdentitySourceType:[11,1,1,""],LockoutPolicy:[11,1,1,""],PasswordPolicy:[11,1,1,""],Privileges:[11,1,1,""],Roles:[11,1,1,""],StubFactory:[11,1,1,""],TokenPolicy:[11,1,1,""],VCGroups:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.IdentitySourceType":{AD_OVER_IWA:[11,3,1,""],AD_OVER_LDAP:[11,3,1,""],IDP_ADFS:[11,3,1,""],IDP_CSP:[11,3,1,""],IDP_VMWAREID:[11,3,1,""],IDP_WS1B:[11,3,1,""],OPEN_LDAP:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory":{cluster:[13,0,0,"-"],cluster_client:[12,0,0,"-"],common_client:[12,0,0,"-"],datacenter_client:[12,0,0,"-"],datastore_client:[12,0,0,"-"],folder_client:[12,0,0,"-"],host_client:[12,0,0,"-"],network_client:[12,0,0,"-"],resourcepool_client:[12,0,0,"-"],vm_client:[12,0,0,"-"]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster":{drs_client:[13,0,0,"-"],ha_client:[13,0,0,"-"],vsan_client:[13,0,0,"-"]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client":{AdditionalOptions:[13,1,1,""],AffinityRule:[13,1,1,""],Automation:[13,1,1,""],DependencyRule:[13,1,1,""],DpmBehaviorInfo:[13,1,1,""],DrsBehaviorInfo:[13,1,1,""],DrsConfig:[13,1,1,""],DrsVmOverrides:[13,1,1,""],Group:[13,1,1,""],GroupDetails:[13,1,1,""],PowerManagement:[13,1,1,""],ProactiveHAConfig:[13,1,1,""],Rule:[13,1,1,""],ScaleSharesBehavior:[13,1,1,""],Status:[13,1,1,""],StubFactory:[13,1,1,""],VmHostRule:[13,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo":{AUTOMATED:[13,3,1,""],MANUAL:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo":{FULLY_AUTOMATED:[13,3,1,""],MANUAL:[13,3,1,""],PARTIALLY_AUTOMATED:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig":{BehaviorType:[13,1,1,""],RemediationType:[13,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType":{AUTOMATED:[13,3,1,""],MANUAL:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType":{MAINTENANCE_MODE:[13,3,1,""],QUARANTINE_MODE:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior":{DISABLED:[13,3,1,""],SCALE_CPU_AND_MEMORY_SHARES:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status":{GRAY:[13,3,1,""],GREEN:[13,3,1,""],RED:[13,3,1,""],YELLOW:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client":{AdmissionControl:[13,1,1,""],ClusterResourcePercentage:[13,1,1,""],FailuresAndResponses:[13,1,1,""],FixedSizeSlotPolicy:[13,1,1,""],HaVmOverrides:[13,1,1,""],HeartBeatDataStores:[13,1,1,""],StubFactory:[13,1,1,""],VmToolsMonitoringSettings:[13,1,1,""],VsphereHA:[13,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses":{IsolationResponse:[13,1,1,""],RestartPriority:[13,1,1,""],ServiceState:[13,1,1,""],StorageVmReaction:[13,1,1,""],VmMonitoringState:[13,1,1,""],VmReactionOnAPDCleared:[13,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse":{CLUSTER_ISOLATION_RESPONSE:[13,3,1,""],NONE:[13,3,1,""],POWER_OFF:[13,3,1,""],SHUTDOWN:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority":{CLUSTER_RESTART_PRIORITY:[13,3,1,""],DISABLED:[13,3,1,""],HIGH:[13,3,1,""],HIGHEST:[13,3,1,""],LOW:[13,3,1,""],LOWEST:[13,3,1,""],MEDIUM:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState":{DISABLED:[13,3,1,""],ENABLED:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction":{CLUSTER_DEFAULT:[13,3,1,""],DISABLED:[13,3,1,""],RESTART_AGGRESSIVE:[13,3,1,""],RESTART_CONSERVATIVE:[13,3,1,""],WARNING:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState":{VM_AND_APP_MONITORING:[13,3,1,""],VM_MONITORING_DISABLED:[13,3,1,""],VM_MONITORING_ONLY:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared":{NONE:[13,3,1,""],RESET:[13,3,1,""],USE_CLUSTER_DEFAULT:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores":{HBDatastoreCandidate:[13,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate":{ALL_FEASIBLE_DS:[13,3,1,""],ALL_FEASIBLE_DS_WITH_USER_PREFERENCE:[13,3,1,""],USER_SELECTED_DS:[13,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client":{HostDefaultInfo:[13,1,1,""],StubFactory:[13,1,1,""],VsanConfigInfo:[13,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client":{ClusterConfigInfo:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client":{OptionValue:[12,1,1,""],Permission:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client":{Datacenter:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client":{Datastore:[12,1,1,""],MaintenanceModeState:[12,1,1,""],PodStorageDrsEntry:[12,1,1,""],StorageDrsConfigInfo:[12,1,1,""],StorageDrsPodConfigInfo:[12,1,1,""],StoragePod:[12,1,1,""],StubFactory:[12,1,1,""],Summary:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState":{ENTERING_MAINTENANCE:[12,3,1,""],IN_MAINTENANCE:[12,3,1,""],NORMAL:[12,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client":{Folder:[12,1,1,""],FolderDetails:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client":{HostConfig:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client":{Network:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client":{ResourceAllocationInfo:[12,1,1,""],ResourcePool:[12,1,1,""],ResourcePoolSummary:[12,1,1,""],Shares:[12,1,1,""],StubFactory:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares":{Level:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares.Level":{CUSTOM:[12,3,1,""],HIGH:[12,3,1,""],LOW:[12,3,1,""],NORMAL:[12,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client":{ConfigInfo:[12,1,1,""],ResourceAllocationInfo:[12,1,1,""],StubFactory:[12,1,1,""],VirtualHardware:[12,1,1,""],VirtualMachineConfig:[12,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client":{InventoryManagement:[11,1,1,""],Settings:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client":{InventoryAuthorization:[11,1,1,""],Permission:[11,1,1,""],ServiceProviderEntities:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client":{Cluster:[11,1,1,""],DrsConfig:[11,1,1,""],ManagementCluster:[11,1,1,""],ManagementVirtualMachine:[11,1,1,""],ResourceAllocationInfo:[11,1,1,""],ResourceConfigSpec:[11,1,1,""],ResourcePool:[11,1,1,""],Shares:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig":{DrsBehaviorInfo:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo":{FULLY_AUTOMATED:[11,3,1,""],MANUAL:[11,3,1,""],PARTIALLY_AUTOMATED:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine":{ManagementVMType:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType":{CLOUD_GATEWAY:[11,3,1,""],VCENTER:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares":{Level:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level":{CUSTOM:[11,3,1,""],HIGH:[11,3,1,""],LOW:[11,3,1,""],NORMAL:[11,3,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client":{StubFactory:[11,1,1,""],VsphereUIConfiguration:[11,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config.components_client":{StubFactory:[10,1,1,""]},"com.vmware.appliance.vcenter.settings.v1.config_client":{StubFactory:[9,1,1,""]},"com.vmware.appliance.vcenter.settings.v1_client":{ApplyImpact:[8,1,1,""],CheckResult:[8,1,1,""],ComplianceResult:[8,1,1,""],Config:[8,1,1,""],ConfigCurrent:[8,1,1,""],DesiredState:[8,1,1,""],DiffResult:[8,1,1,""],Impact:[8,1,1,""],Notification:[8,1,1,""],Notifications:[8,1,1,""],ScanResult:[8,1,1,""],StatusType:[8,1,1,""],StubFactory:[8,1,1,""],TaskInfo:[8,1,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.ApplyImpact":{NO_IMPACT:[8,3,1,""],REBOOT_REQUIRED:[8,3,1,""],RESTART_SERVICE:[8,3,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.Config":{"delete":[8,2,1,""],ApplyDesiredStateSpec:[8,1,1,""],ApplyResult:[8,1,1,""],ApplySpec:[8,1,1,""],ApplyStatus:[8,1,1,""],CheckDesiredStateSpec:[8,1,1,""],CheckSpec:[8,1,1,""],CreateSpec:[8,1,1,""],Info:[8,1,1,""],ScanSpec:[8,1,1,""],apply_desired_state_task:[8,2,1,""],check_desired_state_task:[8,2,1,""],create:[8,2,1,""],get:[8,2,1,""],scan_desired_state_task:[8,2,1,""],scan_task:[8,2,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.Config.ApplyStatus":{ERROR:[8,3,1,""],SKIPPED:[8,3,1,""],SUCCESS:[8,3,1,""],TIMED_OUT:[8,3,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.ConfigCurrent":{InvokerType:[8,1,1,""],get:[8,2,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.ConfigCurrent.InvokerType":{INTERNAL:[8,3,1,""],USER:[8,3,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.ScanResult":{ComplianceStatus:[8,1,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus":{COMPLIANT:[8,3,1,""],NON_COMPLIANT:[8,3,1,""],UNAVAILABLE:[8,3,1,""]},"com.vmware.appliance.vcenter.settings.v1_client.StatusType":{INVALID:[8,3,1,""],VALID:[8,3,1,""]},"com.vmware.appliance.vmon_client":{Service:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.appliance.vmon_client.Service":{Health:[2,1,1,""],Info:[2,1,1,""],StartupType:[2,1,1,""],State:[2,1,1,""],UpdateSpec:[2,1,1,""],get:[2,2,1,""],list_details:[2,2,1,""],restart:[2,2,1,""],start:[2,2,1,""],stop:[2,2,1,""],update:[2,2,1,""]},"com.vmware.appliance.vmon_client.Service.Health":{DEGRADED:[2,3,1,""],HEALTHY:[2,3,1,""],HEALTHY_WITH_WARNINGS:[2,3,1,""]},"com.vmware.appliance.vmon_client.Service.StartupType":{AUTOMATIC:[2,3,1,""],DISABLED:[2,3,1,""],MANUAL:[2,3,1,""]},"com.vmware.appliance.vmon_client.Service.State":{STARTED:[2,3,1,""],STARTING:[2,3,1,""],STOPPED:[2,3,1,""],STOPPING:[2,3,1,""]},"com.vmware.appliance_client":{Health:[1,1,1,""],HealthCheckSettings:[1,1,1,""],LocalAccounts:[1,1,1,""],Monitoring:[1,1,1,""],Networking:[1,1,1,""],Notification:[1,1,1,""],Notifications:[1,1,1,""],Ntp:[1,1,1,""],Recovery:[1,1,1,""],Services:[1,1,1,""],Shutdown:[1,1,1,""],StubFactory:[1,1,1,""],SubtaskInfo:[1,1,1,""],SupportBundle:[1,1,1,""],TaskInfo:[1,1,1,""],Timesync:[1,1,1,""],Update:[1,1,1,""]},"com.vmware.appliance_client.Health":{messages:[1,2,1,""]},"com.vmware.appliance_client.HealthCheckSettings":{SettingSpec:[1,1,1,""],UpdateSpec:[1,1,1,""],get:[1,2,1,""],update:[1,2,1,""]},"com.vmware.appliance_client.LocalAccounts":{"delete":[1,2,1,""],Config:[1,1,1,""],Info:[1,1,1,""],UpdateConfig:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],set:[1,2,1,""],update:[1,2,1,""]},"com.vmware.appliance_client.Monitoring":{FunctionType:[1,1,1,""],IntervalType:[1,1,1,""],MonitoredItem:[1,1,1,""],MonitoredItemData:[1,1,1,""],MonitoredItemDataRequest:[1,1,1,""],get:[1,2,1,""],list:[1,2,1,""],query:[1,2,1,""]},"com.vmware.appliance_client.Monitoring.FunctionType":{AVG:[1,3,1,""],COUNT:[1,3,1,""],MAX:[1,3,1,""],MIN:[1,3,1,""]},"com.vmware.appliance_client.Monitoring.IntervalType":{DAY1:[1,3,1,""],HOURS2:[1,3,1,""],HOURS6:[1,3,1,""],MINUTES30:[1,3,1,""],MINUTES5:[1,3,1,""]},"com.vmware.appliance_client.Networking":{ChangeSpec:[1,1,1,""],DNSInfo:[1,1,1,""],Info:[1,1,1,""],UpdateSpec:[1,1,1,""],change_task:[1,2,1,""],get:[1,2,1,""],reset:[1,2,1,""],update:[1,2,1,""]},"com.vmware.appliance_client.Networking.DNSInfo":{DNSMode:[1,1,1,""]},"com.vmware.appliance_client.Networking.DNSInfo.DNSMode":{DHCP:[1,3,1,""],STATIC:[1,3,1,""]},"com.vmware.appliance_client.Ntp":{LocalizableMessage:[1,1,1,""],ServerStatus:[1,1,1,""],TestRunStatus:[1,1,1,""],get:[1,2,1,""],set:[1,2,1,""],test:[1,2,1,""]},"com.vmware.appliance_client.Ntp.ServerStatus":{SERVER_REACHABLE:[1,3,1,""],SERVER_UNREACHABLE:[1,3,1,""]},"com.vmware.appliance_client.Recovery":{Info:[1,1,1,""],get:[1,2,1,""]},"com.vmware.appliance_client.Services":{Info:[1,1,1,""],State:[1,1,1,""],get:[1,2,1,""],list:[1,2,1,""],restart:[1,2,1,""],start:[1,2,1,""],stop:[1,2,1,""]},"com.vmware.appliance_client.Services.State":{STARTED:[1,3,1,""],STARTING:[1,3,1,""],STOPPED:[1,3,1,""],STOPPING:[1,3,1,""]},"com.vmware.appliance_client.Shutdown":{ShutdownConfig:[1,1,1,""],cancel:[1,2,1,""],get:[1,2,1,""],poweroff:[1,2,1,""],reboot:[1,2,1,""]},"com.vmware.appliance_client.SupportBundle":{CreateSpec:[1,1,1,""],CreationStatus:[1,1,1,""],FilterSpec:[1,1,1,""],Info:[1,1,1,""],IterationSpec:[1,1,1,""],ListResult:[1,1,1,""],create_task:[1,2,1,""],list:[1,2,1,""]},"com.vmware.appliance_client.SupportBundle.CreationStatus":{CANCELLED:[1,3,1,""],FAILED:[1,3,1,""],SUCCEEDED:[1,3,1,""]},"com.vmware.appliance_client.Timesync":{TimeSyncMode:[1,1,1,""],get:[1,2,1,""],set:[1,2,1,""]},"com.vmware.appliance_client.Timesync.TimeSyncMode":{DISABLED:[1,3,1,""],HOST:[1,3,1,""],NTP:[1,3,1,""]},"com.vmware.appliance_client.Update":{Info:[1,1,1,""],State:[1,1,1,""],cancel:[1,2,1,""],get:[1,2,1,""]},"com.vmware.appliance_client.Update.State":{INSTALL_FAILED:[1,3,1,""],INSTALL_IN_PROGRESS:[1,3,1,""],ROLLBACK_IN_PROGRESS:[1,3,1,""],STAGE_IN_PROGRESS:[1,3,1,""],UPDATES_PENDING:[1,3,1,""],UP_TO_DATE:[1,3,1,""]},"com.vmware.cis":{tagging_client:[14,0,0,"-"],task_client:[14,0,0,"-"]},"com.vmware.cis.tagging_client":{Category:[14,1,1,""],CategoryModel:[14,1,1,""],StubFactory:[14,1,1,""],Tag:[14,1,1,""],TagAssociation:[14,1,1,""],TagModel:[14,1,1,""]},"com.vmware.cis.tagging_client.Category":{"delete":[14,2,1,""],CreateSpec:[14,1,1,""],UpdateSpec:[14,1,1,""],add_to_used_by:[14,2,1,""],create:[14,2,1,""],get:[14,2,1,""],list:[14,2,1,""],list_used_categories:[14,2,1,""],remove_from_used_by:[14,2,1,""],revoke_propagating_permissions:[14,2,1,""],update:[14,2,1,""]},"com.vmware.cis.tagging_client.CategoryModel":{Cardinality:[14,1,1,""]},"com.vmware.cis.tagging_client.CategoryModel.Cardinality":{MULTIPLE:[14,3,1,""],SINGLE:[14,3,1,""]},"com.vmware.cis.tagging_client.Tag":{"delete":[14,2,1,""],CreateSpec:[14,1,1,""],UpdateSpec:[14,1,1,""],add_to_used_by:[14,2,1,""],create:[14,2,1,""],get:[14,2,1,""],list:[14,2,1,""],list_tags_for_category:[14,2,1,""],list_used_tags:[14,2,1,""],remove_from_used_by:[14,2,1,""],revoke_propagating_permissions:[14,2,1,""],update:[14,2,1,""]},"com.vmware.cis.tagging_client.TagAssociation":{BatchResult:[14,1,1,""],ObjectToTags:[14,1,1,""],TagToObjects:[14,1,1,""],attach:[14,2,1,""],attach_multiple_tags_to_object:[14,2,1,""],attach_tag_to_multiple_objects:[14,2,1,""],detach:[14,2,1,""],detach_multiple_tags_from_object:[14,2,1,""],detach_tag_from_multiple_objects:[14,2,1,""],list_attachable_tags:[14,2,1,""],list_attached_objects:[14,2,1,""],list_attached_objects_on_tags:[14,2,1,""],list_attached_tags:[14,2,1,""],list_attached_tags_on_objects:[14,2,1,""]},"com.vmware.cis.task_client":{CommonInfo:[14,1,1,""],Info:[14,1,1,""],Progress:[14,1,1,""],Status:[14,1,1,""],StubFactory:[14,1,1,""]},"com.vmware.cis.task_client.Status":{BLOCKED:[14,3,1,""],FAILED:[14,3,1,""],PENDING:[14,3,1,""],RUNNING:[14,3,1,""],SUCCEEDED:[14,3,1,""]},"com.vmware.cis_client":{Session:[1,1,1,""],StubFactory:[1,1,1,""],Tasks:[1,1,1,""]},"com.vmware.cis_client.Session":{"delete":[1,2,1,""],Info:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""]},"com.vmware.cis_client.Tasks":{FilterSpec:[1,1,1,""],GetSpec:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],cancel:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.content":{library:[16,0,0,"-"],library_client:[15,0,0,"-"],type:[18,0,0,"-"]},"com.vmware.content.library":{item:[17,0,0,"-"],item_client:[16,0,0,"-"]},"com.vmware.content.library.item":{downloadsession_client:[17,0,0,"-"],updatesession_client:[17,0,0,"-"]},"com.vmware.content.library.item.downloadsession_client":{File:[17,1,1,""],StubFactory:[17,1,1,""]},"com.vmware.content.library.item.downloadsession_client.File":{EndpointType:[17,1,1,""],Info:[17,1,1,""],PrepareStatus:[17,1,1,""],get:[17,2,1,""],list:[17,2,1,""],prepare:[17,2,1,""]},"com.vmware.content.library.item.downloadsession_client.File.EndpointType":{DIRECT:[17,3,1,""],HTTPS:[17,3,1,""]},"com.vmware.content.library.item.downloadsession_client.File.PrepareStatus":{ERROR:[17,3,1,""],PREPARED:[17,3,1,""],PREPARE_REQUESTED:[17,3,1,""],PREPARING:[17,3,1,""],UNPREPARED:[17,3,1,""]},"com.vmware.content.library.item.updatesession_client":{CertificateInfo:[17,1,1,""],File:[17,1,1,""],PreviewInfo:[17,1,1,""],PreviewWarningInfo:[17,1,1,""],StubFactory:[17,1,1,""],WarningBehavior:[17,1,1,""],WarningType:[17,1,1,""]},"com.vmware.content.library.item.updatesession_client.File":{AddSpec:[17,1,1,""],Info:[17,1,1,""],SourceType:[17,1,1,""],ValidationError:[17,1,1,""],ValidationResult:[17,1,1,""],add:[17,2,1,""],get:[17,2,1,""],list:[17,2,1,""],remove:[17,2,1,""],validate:[17,2,1,""]},"com.vmware.content.library.item.updatesession_client.File.SourceType":{NONE:[17,3,1,""],PULL:[17,3,1,""],PUSH:[17,3,1,""]},"com.vmware.content.library.item.updatesession_client.PreviewInfo":{State:[17,1,1,""]},"com.vmware.content.library.item.updatesession_client.PreviewInfo.State":{AVAILABLE:[17,3,1,""],NOT_APPLICABLE:[17,3,1,""],PREPARING:[17,3,1,""],UNAVAILABLE:[17,3,1,""]},"com.vmware.content.library.item.updatesession_client.WarningType":{EXPIRED_CERTIFICATE:[17,3,1,""],NOT_YET_VALID_CERTIFICATE:[17,3,1,""],SELF_SIGNED_CERTIFICATE:[17,3,1,""],UNTRUSTED_CERTIFICATE:[17,3,1,""]},"com.vmware.content.library.item_client":{CertVerificationStatus:[16,1,1,""],CertificateVerificationInfo:[16,1,1,""],Changes:[16,1,1,""],DownloadSession:[16,1,1,""],DownloadSessionModel:[16,1,1,""],File:[16,1,1,""],Storage:[16,1,1,""],StubFactory:[16,1,1,""],TransferEndpoint:[16,1,1,""],TransferStatus:[16,1,1,""],UpdateSession:[16,1,1,""],UpdateSessionModel:[16,1,1,""]},"com.vmware.content.library.item_client.CertVerificationStatus":{INTERNAL:[16,3,1,""],NOT_AVAILABLE:[16,3,1,""],UNTRUSTED:[16,3,1,""],VERIFICATION_FAILURE:[16,3,1,""],VERIFICATION_IN_PROGRESS:[16,3,1,""],VERIFIED:[16,3,1,""]},"com.vmware.content.library.item_client.Changes":{Info:[16,1,1,""],RESOURCE_TYPE:[16,3,1,""],Summary:[16,1,1,""],get:[16,2,1,""],list:[16,2,1,""]},"com.vmware.content.library.item_client.DownloadSession":{"delete":[16,2,1,""],RESOURCE_TYPE:[16,3,1,""],cancel:[16,2,1,""],create:[16,2,1,""],fail:[16,2,1,""],get:[16,2,1,""],keep_alive:[16,2,1,""],list:[16,2,1,""]},"com.vmware.content.library.item_client.DownloadSessionModel":{State:[16,1,1,""]},"com.vmware.content.library.item_client.DownloadSessionModel.State":{ACTIVE:[16,3,1,""],CANCELED:[16,3,1,""],ERROR:[16,3,1,""]},"com.vmware.content.library.item_client.File":{ChecksumAlgorithm:[16,1,1,""],ChecksumInfo:[16,1,1,""],Info:[16,1,1,""],get:[16,2,1,""],list:[16,2,1,""]},"com.vmware.content.library.item_client.File.ChecksumAlgorithm":{MD5:[16,3,1,""],SHA1:[16,3,1,""],SHA256:[16,3,1,""],SHA512:[16,3,1,""]},"com.vmware.content.library.item_client.Storage":{Info:[16,1,1,""],get:[16,2,1,""],list:[16,2,1,""]},"com.vmware.content.library.item_client.TransferStatus":{ERROR:[16,3,1,""],READY:[16,3,1,""],TRANSFERRING:[16,3,1,""],VALIDATING:[16,3,1,""],WAITING_FOR_TRANSFER:[16,3,1,""]},"com.vmware.content.library.item_client.UpdateSession":{"delete":[16,2,1,""],RESOURCE_TYPE:[16,3,1,""],cancel:[16,2,1,""],complete:[16,2,1,""],create:[16,2,1,""],fail:[16,2,1,""],get:[16,2,1,""],keep_alive:[16,2,1,""],list:[16,2,1,""],update:[16,2,1,""]},"com.vmware.content.library.item_client.UpdateSessionModel":{State:[16,1,1,""]},"com.vmware.content.library.item_client.UpdateSessionModel.State":{ACTIVE:[16,3,1,""],CANCELED:[16,3,1,""],DONE:[16,3,1,""],ERROR:[16,3,1,""]},"com.vmware.content.library_client":{Item:[15,1,1,""],ItemModel:[15,1,1,""],OptimizationInfo:[15,1,1,""],PublishInfo:[15,1,1,""],SourceInfo:[15,1,1,""],StorageBacking:[15,1,1,""],StubFactory:[15,1,1,""],SubscribedItem:[15,1,1,""],SubscriptionInfo:[15,1,1,""],Subscriptions:[15,1,1,""]},"com.vmware.content.library_client.Item":{"delete":[15,2,1,""],DestinationSpec:[15,1,1,""],FindSpec:[15,1,1,""],RESOURCE_TYPE:[15,3,1,""],copy:[15,2,1,""],create:[15,2,1,""],find:[15,2,1,""],get:[15,2,1,""],list:[15,2,1,""],publish:[15,2,1,""],update:[15,2,1,""]},"com.vmware.content.library_client.PublishInfo":{AuthenticationMethod:[15,1,1,""]},"com.vmware.content.library_client.PublishInfo.AuthenticationMethod":{BASIC:[15,3,1,""],NONE:[15,3,1,""]},"com.vmware.content.library_client.StorageBacking":{Type:[15,1,1,""]},"com.vmware.content.library_client.StorageBacking.Type":{DATASTORE:[15,3,1,""],OTHER:[15,3,1,""]},"com.vmware.content.library_client.SubscribedItem":{evict:[15,2,1,""],sync:[15,2,1,""]},"com.vmware.content.library_client.SubscriptionInfo":{AuthenticationMethod:[15,1,1,""]},"com.vmware.content.library_client.SubscriptionInfo.AuthenticationMethod":{BASIC:[15,3,1,""],NONE:[15,3,1,""]},"com.vmware.content.library_client.Subscriptions":{"delete":[15,2,1,""],CreateSpec:[15,1,1,""],CreateSpecNewSubscribedLibrary:[15,1,1,""],CreateSpecPlacement:[15,1,1,""],CreateSpecSubscribedLibrary:[15,1,1,""],CreateSpecVcenter:[15,1,1,""],Info:[15,1,1,""],Location:[15,1,1,""],PlacementInfo:[15,1,1,""],RESOURCE_TYPE:[15,3,1,""],Summary:[15,1,1,""],UpdateSpec:[15,1,1,""],UpdateSpecPlacement:[15,1,1,""],UpdateSpecVcenter:[15,1,1,""],VcenterInfo:[15,1,1,""],create:[15,2,1,""],get:[15,2,1,""],list:[15,2,1,""],update:[15,2,1,""]},"com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary":{Target:[15,1,1,""]},"com.vmware.content.library_client.Subscriptions.CreateSpecSubscribedLibrary.Target":{CREATE_NEW:[15,3,1,""],USE_EXISTING:[15,3,1,""]},"com.vmware.content.library_client.Subscriptions.Location":{LOCAL:[15,3,1,""],REMOTE:[15,3,1,""]},"com.vmware.content.type":{ovf:[19,0,0,"-"],ovf_client:[18,0,0,"-"]},"com.vmware.content.type.ovf":{policy_client:[19,0,0,"-"]},"com.vmware.content.type.ovf.policy_client":{StoragePolicy:[19,1,1,""],StoragePolicyGroup:[19,1,1,""],StubFactory:[19,1,1,""]},"com.vmware.content.type.ovf_client":{Cpu:[18,1,1,""],Disk:[18,1,1,""],DiskController:[18,1,1,""],Drive:[18,1,1,""],Floppy:[18,1,1,""],Memory:[18,1,1,""],Network:[18,1,1,""],Nic:[18,1,1,""],OvfTemplate:[18,1,1,""],StubFactory:[18,1,1,""],USBController:[18,1,1,""],VAppTemplate:[18,1,1,""],VideoCard:[18,1,1,""],VmTemplate:[18,1,1,""]},"com.vmware.content_client":{Configuration:[1,1,1,""],ConfigurationModel:[1,1,1,""],Library:[1,1,1,""],LibraryModel:[1,1,1,""],LocalLibrary:[1,1,1,""],SecurityPolicies:[1,1,1,""],SecurityRuleType:[1,1,1,""],StubFactory:[1,1,1,""],SubscribedLibrary:[1,1,1,""],TrustedCertificates:[1,1,1,""],Type:[1,1,1,""]},"com.vmware.content_client.Configuration":{get:[1,2,1,""],update:[1,2,1,""]},"com.vmware.content_client.Library":{FindSpec:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],find:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.content_client.LibraryModel":{LibraryType:[1,1,1,""]},"com.vmware.content_client.LibraryModel.LibraryType":{LOCAL:[1,3,1,""],SUBSCRIBED:[1,3,1,""]},"com.vmware.content_client.LocalLibrary":{"delete":[1,2,1,""],DestinationSpec:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],publish:[1,2,1,""],update:[1,2,1,""]},"com.vmware.content_client.SecurityPolicies":{Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],list:[1,2,1,""]},"com.vmware.content_client.SecurityRuleType":{OVF_STRICT_VERIFICATION:[1,3,1,""]},"com.vmware.content_client.SubscribedLibrary":{"delete":[1,2,1,""],ProbeResult:[1,1,1,""],create:[1,2,1,""],evict:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],probe:[1,2,1,""],sync:[1,2,1,""],update:[1,2,1,""]},"com.vmware.content_client.SubscribedLibrary.ProbeResult":{Status:[1,1,1,""]},"com.vmware.content_client.SubscribedLibrary.ProbeResult.Status":{CERTIFICATE_ERROR:[1,3,1,""],HOST_NOT_FOUND:[1,3,1,""],INVALID_CREDENTIALS:[1,3,1,""],INVALID_URL:[1,3,1,""],RESOURCE_NOT_FOUND:[1,3,1,""],SUCCESS:[1,3,1,""],TIMED_OUT:[1,3,1,""],UNKNOWN_ERROR:[1,3,1,""]},"com.vmware.content_client.TrustedCertificates":{"delete":[1,2,1,""],CreateSpec:[1,1,1,""],Info:[1,1,1,""],ListResult:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.content_client.Type":{Info:[1,1,1,""],list:[1,2,1,""]},"com.vmware.esx":{hcl:[21,0,0,"-"],hcl_client:[20,0,0,"-"],hosts:[22,0,0,"-"],hosts_client:[20,0,0,"-"],settings:[23,0,0,"-"],settings_client:[20,0,0,"-"]},"com.vmware.esx.hcl":{hosts_client:[21,0,0,"-"]},"com.vmware.esx.hcl.hosts_client":{CompatibilityReleases:[21,1,1,""],CompatibilityReport:[21,1,1,""],StubFactory:[21,1,1,""]},"com.vmware.esx.hcl.hosts_client.CompatibilityReleases":{EsxiCompatibilityReleases:[21,1,1,""],list:[21,2,1,""]},"com.vmware.esx.hcl.hosts_client.CompatibilityReport":{BiosConstraint:[21,1,1,""],DeviceConstraint:[21,1,1,""],DeviceHclInfo:[21,1,1,""],HclReport:[21,1,1,""],Result:[21,1,1,""],ServerCompatibility:[21,1,1,""],ServerHclInfo:[21,1,1,""],Spec:[21,1,1,""],create_task:[21,2,1,""],get:[21,2,1,""]},"com.vmware.esx.hcl_client":{CompatibilityData:[20,1,1,""],CompatibilityStatus:[20,1,1,""],Driver:[20,1,1,""],Firmware:[20,1,1,""],Notification:[20,1,1,""],Notifications:[20,1,1,""],PCIDevice:[20,1,1,""],Reports:[20,1,1,""],Server:[20,1,1,""],StubFactory:[20,1,1,""]},"com.vmware.esx.hcl_client.CompatibilityData":{Status:[20,1,1,""],get:[20,2,1,""],update_task:[20,2,1,""]},"com.vmware.esx.hcl_client.CompatibilityStatus":{CERTIFIED:[20,3,1,""],COMPATIBLE:[20,3,1,""],INCOMPATIBLE:[20,3,1,""],NOT_CERTIFIED:[20,3,1,""],UNAVAILABLE:[20,3,1,""]},"com.vmware.esx.hcl_client.Reports":{Location:[20,1,1,""],Token:[20,1,1,""],get:[20,2,1,""]},"com.vmware.esx.hosts":{software_client:[22,0,0,"-"]},"com.vmware.esx.hosts.software_client":{InstalledComponents:[22,1,1,""],StubFactory:[22,1,1,""]},"com.vmware.esx.hosts.software_client.InstalledComponents":{InstalledComponentInfo:[22,1,1,""],list:[22,2,1,""]},"com.vmware.esx.hosts_client":{AddOnInfo:[20,1,1,""],AddOnSpec:[20,1,1,""],BaseImageInfo:[20,1,1,""],BaseImageSpec:[20,1,1,""],CertificateInfo:[20,1,1,""],ComponentInfo:[20,1,1,""],HardwareSupportInfo:[20,1,1,""],HardwareSupportPackageInfo:[20,1,1,""],HardwareSupportPackageSpec:[20,1,1,""],HardwareSupportSpec:[20,1,1,""],Notification:[20,1,1,""],Notifications:[20,1,1,""],Software:[20,1,1,""],SoftwareInfo:[20,1,1,""],SoftwareSpec:[20,1,1,""],SolutionComponentSpec:[20,1,1,""],SolutionInfo:[20,1,1,""],SolutionSpec:[20,1,1,""],StubFactory:[20,1,1,""]},"com.vmware.esx.hosts_client.Software":{ConnectionSpec:[20,1,1,""],HostCredentials:[20,1,1,""],Info:[20,1,1,""],get:[20,2,1,""]},"com.vmware.esx.hosts_client.Software.ConnectionSpec":{AuthenticationType:[20,1,1,""]},"com.vmware.esx.hosts_client.Software.ConnectionSpec.AuthenticationType":{EXISTING:[20,3,1,""],USERNAME_PASSWORD:[20,3,1,""]},"com.vmware.esx.settings":{clusters:[24,0,0,"-"],clusters_client:[23,0,0,"-"],defaults:[32,0,0,"-"],defaults_client:[23,0,0,"-"],depot_content:[37,0,0,"-"],depot_content_client:[23,0,0,"-"],depots:[38,0,0,"-"],depots_client:[23,0,0,"-"],hardware_support:[39,0,0,"-"],hardware_support_client:[23,0,0,"-"],hosts:[41,0,0,"-"],hosts_client:[23,0,0,"-"]},"com.vmware.esx.settings.clusters":{configuration:[25,0,0,"-"],configuration_client:[24,0,0,"-"],enablement:[26,0,0,"-"],enablement_client:[24,0,0,"-"],policies:[27,0,0,"-"],policies_client:[24,0,0,"-"],software:[28,0,0,"-"],software_client:[24,0,0,"-"]},"com.vmware.esx.settings.clusters.configuration":{reports_client:[25,0,0,"-"]},"com.vmware.esx.settings.clusters.configuration.reports_client":{LastApplyResult:[25,1,1,""],LastComplianceResult:[25,1,1,""],LastPrecheckResult:[25,1,1,""],RecentTasks:[25,1,1,""],StubFactory:[25,1,1,""]},"com.vmware.esx.settings.clusters.configuration.reports_client.LastApplyResult":{get:[25,2,1,""]},"com.vmware.esx.settings.clusters.configuration.reports_client.LastComplianceResult":{get:[25,2,1,""]},"com.vmware.esx.settings.clusters.configuration.reports_client.LastPrecheckResult":{get:[25,2,1,""]},"com.vmware.esx.settings.clusters.configuration.reports_client.RecentTasks":{DraftTasks:[25,1,1,""],Info:[25,1,1,""],get:[25,2,1,""]},"com.vmware.esx.settings.clusters.configuration_client":{AuditRecords:[24,1,1,""],ClusterCompliance:[24,1,1,""],ClusterPrecheckResult:[24,1,1,""],ComplianceInfo:[24,1,1,""],ComplianceStatus:[24,1,1,""],ConfigurationSpec:[24,1,1,""],DependencyError:[24,1,1,""],DetailedValidationError:[24,1,1,""],DocumentStructure:[24,1,1,""],DraftImportResult:[24,1,1,""],Drafts:[24,1,1,""],ExportResult:[24,1,1,""],HostCompliance:[24,1,1,""],HostPrecheckResult:[24,1,1,""],HostResult:[24,1,1,""],HostStatus:[24,1,1,""],ImpactInfo:[24,1,1,""],ImpactType:[24,1,1,""],ImportResult:[24,1,1,""],Schema:[24,1,1,""],SchemaResult:[24,1,1,""],SettingCompliance:[24,1,1,""],StubFactory:[24,1,1,""],ValidationError:[24,1,1,""],ValidationResult:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.AuditRecords":{FilterSpec:[24,1,1,""],Info:[24,1,1,""],OperationDetails:[24,1,1,""],OperationType:[24,1,1,""],TimePeriod:[24,1,1,""],list:[24,2,1,""]},"com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec":{Timeframe:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe":{CUSTOM:[24,3,1,""],SIX_MONTHS:[24,3,1,""],THREE_MONTHS:[24,3,1,""],YEAR:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType":{CHECK_COMPLIANCE:[24,3,1,""],DRAFT_APPLY:[24,3,1,""],DRAFT_CHECK_COMPLIANCE:[24,3,1,""],DRAFT_CREATE:[24,3,1,""],DRAFT_DELETE:[24,3,1,""],DRAFT_EXPORT_CONFIG:[24,3,1,""],DRAFT_GET:[24,3,1,""],DRAFT_IMPORT_FROM_HOST:[24,3,1,""],DRAFT_LIST:[24,3,1,""],DRAFT_PRECHECK:[24,3,1,""],DRAFT_SHOW_CHANGES:[24,3,1,""],DRAFT_UPDATE:[24,3,1,""],EXPORT:[24,3,1,""],IMPORT:[24,3,1,""],OPERATIONS:[24,3,1,""],PRE_CHECK:[24,3,1,""],REMEDIATE:[24,3,1,""],TRANSITION_ENABLE:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance":{Status:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status":{COMPLIANT:[24,3,1,""],NOT_COMPLIANT:[24,3,1,""],RUNNING:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult":{Status:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status":{ERROR:[24,3,1,""],OK:[24,3,1,""],RUNNING:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus":{COMPLIANT:[24,3,1,""],NON_COMPLIANT:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError":{ErrorType:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType":{ADDITIONAL_PROPERTY:[24,3,1,""],DUPLICATE_INSTANCE_ID:[24,3,1,""],EMPTY_PROPERTY:[24,3,1,""],GENERIC:[24,3,1,""],HOST_SPECIFIC_IN_PROFILE:[24,3,1,""],HOST_SPECIFIC_KEY_IN_OVERRIDE:[24,3,1,""],INVALID_DELETE_DEFAULT:[24,3,1,""],INVALID_ENUM_OPTION:[24,3,1,""],INVALID_TYPE:[24,3,1,""],INVALID_UNION_TAG:[24,3,1,""],KEY_IN_HOST_OVERRIDE:[24,3,1,""],MAX_ARRAY_LENGTH:[24,3,1,""],MAX_STRING_LENGTH:[24,3,1,""],MAX_VALUE:[24,3,1,""],MIN_ARRAY_LENGTH:[24,3,1,""],MIN_STRING_LENGTH:[24,3,1,""],MIN_VALUE:[24,3,1,""],MISSING_INSTANCE_ID:[24,3,1,""],MISSING_REQUIRED:[24,3,1,""],MISSING_REQUIRED_PROFILE_INSTANCE:[24,3,1,""],MISSING_REQUIRED_PROFILE_KEY:[24,3,1,""],NOT_HOST_SPECIFIC:[24,3,1,""],NULL_VALUE:[24,3,1,""],PATTERN_MISMATCH:[24,3,1,""],PLACEHOLDER_FOUND:[24,3,1,""],PROPERTY_NAME_MISMATCH:[24,3,1,""],SCHEMA_NOT_FOUND:[24,3,1,""],UNION_CASE_WITHOUT_UNION_TAG:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.DocumentStructure":{HOST_ORIENTED:[24,3,1,""],PROFILE_ORIENTED:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.DraftImportResult":{Status:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status":{CANCELED:[24,3,1,""],ERROR:[24,3,1,""],OK:[24,3,1,""],RUNNING:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.Drafts":{"delete":[24,2,1,""],ApplyResult:[24,1,1,""],ApplySpec:[24,1,1,""],ChangeDetails:[24,1,1,""],ChangedProperty:[24,1,1,""],ChangesResult:[24,1,1,""],ConflictDetails:[24,1,1,""],ConflictPropertyInfo:[24,1,1,""],CreateSpec:[24,1,1,""],DeletionInfo:[24,1,1,""],Info:[24,1,1,""],Metadata:[24,1,1,""],ModificationInfo:[24,1,1,""],RESOURCE_TYPE:[24,3,1,""],State:[24,1,1,""],UpdateSpec:[24,1,1,""],ValidationDetails:[24,1,1,""],ValidationErrors:[24,1,1,""],apply:[24,2,1,""],check_compliance_task:[24,2,1,""],create:[24,2,1,""],export_config:[24,2,1,""],get:[24,2,1,""],import_from_host_task:[24,2,1,""],list:[24,2,1,""],precheck_task:[24,2,1,""],show_changes:[24,2,1,""],update:[24,2,1,""]},"com.vmware.esx.settings.clusters.configuration_client.Drafts.State":{INVALID:[24,3,1,""],VALID:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.HostStatus":{Status:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status":{CANCELED:[24,3,1,""],ERROR:[24,3,1,""],OK:[24,3,1,""],PENDING:[24,3,1,""],RETRY_PENDING:[24,3,1,""],RUNNING:[24,3,1,""],SKIPPED:[24,3,1,""],TIMED_OUT:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ImpactType":{MAINTENANCE_MODE_REQUIRED:[24,3,1,""],NO_IMPACT:[24,3,1,""],REBOOT_REQUIRED:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ImportResult":{Status:[24,1,1,""]},"com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status":{CANCELED:[24,3,1,""],ERROR:[24,3,1,""],OK:[24,3,1,""],RUNNING:[24,3,1,""]},"com.vmware.esx.settings.clusters.configuration_client.Schema":{get:[24,2,1,""]},"com.vmware.esx.settings.clusters.enablement":{configuration_client:[26,0,0,"-"]},"com.vmware.esx.settings.clusters.enablement.configuration_client":{StubFactory:[26,1,1,""],Transition:[26,1,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition":{EligibilityResult:[26,1,1,""],EnableResult:[26,1,1,""],FileSpec:[26,1,1,""],Info:[26,1,1,""],ReferenceHost:[26,1,1,""],Source:[26,1,1,""],State:[26,1,1,""],ValidateResult:[26,1,1,""],cancel:[26,2,1,""],check_eligibility_task:[26,2,1,""],enable_task:[26,2,1,""],export_config:[26,2,1,""],export_schema:[26,2,1,""],get:[26,2,1,""],import_from_file:[26,2,1,""],import_from_host_task:[26,2,1,""],precheck_task:[26,2,1,""],validate_config_task:[26,2,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult":{Status:[26,1,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status":{ELIGIBLE:[26,3,1,""],NOT_ELIGIBLE:[26,3,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult":{Status:[26,1,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status":{ERROR:[26,3,1,""],RUNNING:[26,3,1,""],SUCCESS:[26,3,1,""],SUCCESS_APPLY_INITIATED:[26,3,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info":{Status:[26,1,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status":{ENABLED:[26,3,1,""],ENABLE_IN_PROGRESS:[26,3,1,""],NOT_ALLOWED_IN_CURRENT_STATE:[26,3,1,""],NOT_STARTED:[26,3,1,""],SOFTWARE_SPECIFICATION_NOT_SET:[26,3,1,""],STARTED:[26,3,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source":{FILE:[26,3,1,""],HOST:[26,3,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult":{Status:[26,1,1,""]},"com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status":{INVALID:[26,3,1,""],VALID:[26,3,1,""]},"com.vmware.esx.settings.clusters.enablement_client":{Configuration:[24,1,1,""],Software:[24,1,1,""],StubFactory:[24,1,1,""]},"com.vmware.esx.settings.clusters.enablement_client.Configuration":{Info:[24,1,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.enablement_client.Software":{CheckResult:[24,1,1,""],CheckSpec:[24,1,1,""],CheckType:[24,1,1,""],EnableSpec:[24,1,1,""],Info:[24,1,1,""],check_task:[24,2,1,""],enable_task:[24,2,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.enablement_client.Software.CheckType":{SOFTWARE:[24,3,1,""],SOFTWARE_SPECIFICATION_EXISTENCE:[24,3,1,""],STATELESSNESS:[24,3,1,""],VERSION:[24,3,1,""],VSAN_WITNESS_ELIGIBILITY:[24,3,1,""],VUM_REMEDIATION:[24,3,1,""]},"com.vmware.esx.settings.clusters.policies":{apply_client:[27,0,0,"-"]},"com.vmware.esx.settings.clusters.policies.apply_client":{Effective:[27,1,1,""],StubFactory:[27,1,1,""]},"com.vmware.esx.settings.clusters.policies.apply_client.Effective":{EffectivePolicySpec:[27,1,1,""],FailureAction:[27,1,1,""],ParallelRemediationAction:[27,1,1,""],get:[27,2,1,""]},"com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec":{PreRemediationPowerAction:[27,1,1,""]},"com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[27,3,1,""],POWER_OFF_VMS:[27,3,1,""],SUSPEND_VMS:[27,3,1,""],SUSPEND_VMS_TO_MEMORY:[27,3,1,""]},"com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction":{Action:[27,1,1,""]},"com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action":{FAIL:[27,3,1,""],RETRY:[27,3,1,""]},"com.vmware.esx.settings.clusters.policies_client":{Apply:[24,1,1,""],StubFactory:[24,1,1,""]},"com.vmware.esx.settings.clusters.policies_client.Apply":{ConfiguredPolicySpec:[24,1,1,""],FailureAction:[24,1,1,""],ParallelRemediationAction:[24,1,1,""],get:[24,2,1,""],set:[24,2,1,""]},"com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec":{PreRemediationPowerAction:[24,1,1,""]},"com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[24,3,1,""],POWER_OFF_VMS:[24,3,1,""],SUSPEND_VMS:[24,3,1,""],SUSPEND_VMS_TO_MEMORY:[24,3,1,""]},"com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction":{Action:[24,1,1,""]},"com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action":{FAIL:[24,3,1,""],RETRY:[24,3,1,""]},"com.vmware.esx.settings.clusters.software":{drafts:[29,0,0,"-"],drafts_client:[28,0,0,"-"],reports:[30,0,0,"-"],reports_client:[28,0,0,"-"]},"com.vmware.esx.settings.clusters.software.drafts":{software_client:[29,0,0,"-"]},"com.vmware.esx.settings.clusters.software.drafts.software_client":{AddOn:[29,1,1,""],BaseImage:[29,1,1,""],Components:[29,1,1,""],EffectiveComponents:[29,1,1,""],HardwareSupport:[29,1,1,""],StubFactory:[29,1,1,""]},"com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn":{"delete":[29,2,1,""],RESOURCE_TYPE:[29,3,1,""],get:[29,2,1,""],set:[29,2,1,""]},"com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage":{RESOURCE_TYPE:[29,3,1,""],get:[29,2,1,""],set:[29,2,1,""]},"com.vmware.esx.settings.clusters.software.drafts.software_client.Components":{"delete":[29,2,1,""],RESOURCE_TYPE:[29,3,1,""],UpdateSpec:[29,1,1,""],get:[29,2,1,""],list:[29,2,1,""],set:[29,2,1,""],update:[29,2,1,""]},"com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents":{list:[29,2,1,""]},"com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport":{"delete":[29,2,1,""],get:[29,2,1,""],set:[29,2,1,""]},"com.vmware.esx.settings.clusters.software.drafts_client":{StubFactory:[28,1,1,""]},"com.vmware.esx.settings.clusters.software.reports":{hardware_compatibility:[31,0,0,"-"],hardware_compatibility_client:[30,0,0,"-"]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility":{storage_device_overrides_client:[31,0,0,"-"]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client":{ComplianceStatus:[31,1,1,""],StubFactory:[31,1,1,""],VcgEntries:[31,1,1,""]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus":{ComplianceAction:[31,1,1,""],Key:[31,1,1,""],ReclassificationSpec:[31,1,1,""],Service:[31,1,1,""],UpdateSpec:[31,1,1,""],update_task:[31,2,1,""]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction":{FLAG_AS_INCOMPATIBLE:[31,3,1,""],MARK_AS_VERIFIED:[31,3,1,""],SUPPRESS_WARNING:[31,3,1,""]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Service":{VSAN:[31,3,1,""]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries":{Key:[31,1,1,""],ProductSelectionSpec:[31,1,1,""],UpdateSpec:[31,1,1,""],update_task:[31,2,1,""]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client":{Details:[30,1,1,""],StubFactory:[30,1,1,""]},"com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details":{get:[30,2,1,""]},"com.vmware.esx.settings.clusters.software.reports_client":{ApplyImpact:[28,1,1,""],CheckResult:[28,1,1,""],ComplianceStatus:[28,1,1,""],ComplianceStatusDetail:[28,1,1,""],DriverFirmwareVersion:[28,1,1,""],FirmwareVersionMatchingCriteria:[28,1,1,""],HardwareCompatibility:[28,1,1,""],LastApplyResult:[28,1,1,""],LastCheckResult:[28,1,1,""],PciDevice:[28,1,1,""],PciDeviceCompliance:[28,1,1,""],PciDeviceComplianceInfo:[28,1,1,""],PciDeviceConstraint:[28,1,1,""],Service:[28,1,1,""],StorageDeviceCompatibility:[28,1,1,""],StorageDeviceCompliance:[28,1,1,""],StorageDeviceComplianceInfo:[28,1,1,""],StorageDeviceConstraint:[28,1,1,""],StorageDeviceInfo:[28,1,1,""],StubFactory:[28,1,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact":{ApplyImpactSpec:[28,1,1,""],ClusterImpact:[28,1,1,""],Impact:[28,1,1,""],get:[28,2,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus":{COMPATIBLE:[28,3,1,""],HCL_DATA_UNAVAILABLE:[28,3,1,""],INCOMPATIBLE:[28,3,1,""],NO_FIRMWARE_PROVIDER:[28,3,1,""],UNAVAILABLE:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail":{CERTIFIED:[28,3,1,""],FIRMWARE_VERSION_UNKNOWN:[28,3,1,""],HCL_DATA_UNAVAILABLE:[28,3,1,""],HOSTS_UNAVAILABLE:[28,3,1,""],MUTED:[28,3,1,""],NOT_CERTIFIED:[28,3,1,""],UNKNOWN:[28,3,1,""],USER_FLAGGED:[28,3,1,""],USER_VERIFIED:[28,3,1,""],VENDOR_UPDATE:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.FirmwareVersionMatchingCriteria":{EXACT:[28,3,1,""],MINIMUM:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility":{CheckSummary:[28,1,1,""],ComplianceStatus:[28,1,1,""],check_task:[28,2,1,""],get:[28,2,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus":{COMPATIBLE:[28,3,1,""],HCL_DATA_UNAVAILABLE:[28,3,1,""],INCOMPATIBLE:[28,3,1,""],NO_FIRMWARE_PROVIDER:[28,3,1,""],UNAVAILABLE:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult":{ApplyResult:[28,1,1,""],ApplyStatus:[28,1,1,""],get:[28,2,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus":{Status:[28,1,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status":{ERROR:[28,3,1,""],OK:[28,3,1,""],RETRY_PENDING:[28,3,1,""],SKIPPED:[28,3,1,""],TIMED_OUT:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult":{CheckInfo:[28,1,1,""],CheckResult:[28,1,1,""],CheckStatus:[28,1,1,""],EntityCheckResult:[28,1,1,""],Status:[28,1,1,""],get:[28,2,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult":{EntityType:[28,1,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType":{CLUSTER:[28,3,1,""],HOST:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status":{ERROR:[28,3,1,""],OK:[28,3,1,""],TIMEOUT:[28,3,1,""],WARNING:[28,3,1,""]},"com.vmware.esx.settings.clusters.software.reports_client.Service":{VSAN:[28,3,1,""]},"com.vmware.esx.settings.clusters.software_client":{AddOn:[24,1,1,""],BaseImage:[24,1,1,""],Commits:[24,1,1,""],Compliance:[24,1,1,""],Components:[24,1,1,""],Drafts:[24,1,1,""],EffectiveComponents:[24,1,1,""],HardwareSupport:[24,1,1,""],Recommendations:[24,1,1,""],Solutions:[24,1,1,""],StubFactory:[24,1,1,""]},"com.vmware.esx.settings.clusters.software_client.AddOn":{RESOURCE_TYPE:[24,3,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.BaseImage":{RESOURCE_TYPE:[24,3,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Commits":{Info:[24,1,1,""],RESOURCE_TYPE:[24,3,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Commits.Info":{ApplyStatusType:[24,1,1,""]},"com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType":{APPLIED:[24,3,1,""],NOT_APPLIED:[24,3,1,""]},"com.vmware.esx.settings.clusters.software_client.Compliance":{RESOURCE_TYPE:[24,3,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Components":{RESOURCE_TYPE:[24,3,1,""],get:[24,2,1,""],list:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Drafts":{"delete":[24,2,1,""],CommitSpec:[24,1,1,""],FilterSpec:[24,1,1,""],ImportSpec:[24,1,1,""],Info:[24,1,1,""],Metadata:[24,1,1,""],RESOURCE_TYPE:[24,3,1,""],SourceType:[24,1,1,""],StatusType:[24,1,1,""],Summary:[24,1,1,""],ValidateResult:[24,1,1,""],commit_task:[24,2,1,""],create:[24,2,1,""],get:[24,2,1,""],import_software_spec:[24,2,1,""],list:[24,2,1,""],scan_task:[24,2,1,""],validate_task:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Drafts.SourceType":{CURRENT_SERIES_RECOMMENDATION:[24,3,1,""],JSON_STRING:[24,3,1,""],LATEST_RECOMMENDATION:[24,3,1,""],PULL:[24,3,1,""],PUSH:[24,3,1,""],SPECIFIED_BASE_IMAGE_RECOMMENDATION:[24,3,1,""]},"com.vmware.esx.settings.clusters.software_client.Drafts.StatusType":{INVALID:[24,3,1,""],VALID:[24,3,1,""]},"com.vmware.esx.settings.clusters.software_client.EffectiveComponents":{list:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.HardwareSupport":{get:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Recommendations":{ExplanationDetails:[24,1,1,""],FilterSpec:[24,1,1,""],Info:[24,1,1,""],generate_task:[24,2,1,""],get:[24,2,1,""]},"com.vmware.esx.settings.clusters.software_client.Solutions":{RESOURCE_TYPE:[24,3,1,""],delete_task:[24,2,1,""],get:[24,2,1,""],list:[24,2,1,""],set_task:[24,2,1,""]},"com.vmware.esx.settings.clusters_client":{Configuration:[23,1,1,""],DepotOverrides:[23,1,1,""],Software:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.esx.settings.clusters_client.Configuration":{ApplyResult:[23,1,1,""],ApplySpec:[23,1,1,""],ImportSpec:[23,1,1,""],Info:[23,1,1,""],Metadata:[23,1,1,""],apply_task:[23,2,1,""],check_compliance_task:[23,2,1,""],export_config:[23,2,1,""],get:[23,2,1,""],import_config_task:[23,2,1,""],precheck_task:[23,2,1,""],validate_task:[23,2,1,""]},"com.vmware.esx.settings.clusters_client.DepotOverrides":{Depot:[23,1,1,""],Info:[23,1,1,""],add:[23,2,1,""],get:[23,2,1,""],remove:[23,2,1,""]},"com.vmware.esx.settings.clusters_client.Software":{"export":[23,2,1,""],ApplyResult:[23,1,1,""],ApplySpec:[23,1,1,""],ApplyStatus:[23,1,1,""],CheckInfo:[23,1,1,""],CheckIssue:[23,1,1,""],CheckResult:[23,1,1,""],CheckSpec:[23,1,1,""],CheckStatus:[23,1,1,""],EntityCheckResult:[23,1,1,""],ExportSpec:[23,1,1,""],ExportType:[23,1,1,""],StageResult:[23,1,1,""],StageSpec:[23,1,1,""],StageStatus:[23,1,1,""],Status:[23,1,1,""],apply_task:[23,2,1,""],check_task:[23,2,1,""],get:[23,2,1,""],scan_task:[23,2,1,""],stage_task:[23,2,1,""]},"com.vmware.esx.settings.clusters_client.Software.ApplyStatus":{Status:[23,1,1,""]},"com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status":{ERROR:[23,3,1,""],OK:[23,3,1,""],RETRY_PENDING:[23,3,1,""],RUNNING:[23,3,1,""],SKIPPED:[23,3,1,""],TIMED_OUT:[23,3,1,""]},"com.vmware.esx.settings.clusters_client.Software.EntityCheckResult":{EntityType:[23,1,1,""]},"com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType":{CLUSTER:[23,3,1,""],HOST:[23,3,1,""]},"com.vmware.esx.settings.clusters_client.Software.ExportType":{ISO_IMAGE:[23,3,1,""],OFFLINE_BUNDLE:[23,3,1,""],SOFTWARE_SPEC:[23,3,1,""]},"com.vmware.esx.settings.clusters_client.Software.StageStatus":{Status:[23,1,1,""]},"com.vmware.esx.settings.clusters_client.Software.StageStatus.Status":{ERROR:[23,3,1,""],OK:[23,3,1,""],RETRY_PENDING:[23,3,1,""],RUNNING:[23,3,1,""],SKIPPED:[23,3,1,""],TIMED_OUT:[23,3,1,""]},"com.vmware.esx.settings.clusters_client.Software.Status":{ERROR:[23,3,1,""],OK:[23,3,1,""],RETRY:[23,3,1,""],TIMEOUT:[23,3,1,""],WARNING:[23,3,1,""]},"com.vmware.esx.settings.defaults":{clusters:[33,0,0,"-"],clusters_client:[32,0,0,"-"],hosts:[35,0,0,"-"],hosts_client:[32,0,0,"-"]},"com.vmware.esx.settings.defaults.clusters":{policies:[34,0,0,"-"],policies_client:[33,0,0,"-"]},"com.vmware.esx.settings.defaults.clusters.policies":{apply_client:[34,0,0,"-"]},"com.vmware.esx.settings.defaults.clusters.policies.apply_client":{Effective:[34,1,1,""],StubFactory:[34,1,1,""]},"com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective":{EffectivePolicySpec:[34,1,1,""],FailureAction:[34,1,1,""],ParallelRemediationAction:[34,1,1,""],get:[34,2,1,""]},"com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec":{PreRemediationPowerAction:[34,1,1,""]},"com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[34,3,1,""],POWER_OFF_VMS:[34,3,1,""],SUSPEND_VMS:[34,3,1,""],SUSPEND_VMS_TO_MEMORY:[34,3,1,""]},"com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction":{Action:[34,1,1,""]},"com.vmware.esx.settings.defaults.clusters.policies.apply_client.Effective.FailureAction.Action":{FAIL:[34,3,1,""],RETRY:[34,3,1,""]},"com.vmware.esx.settings.defaults.clusters.policies_client":{Apply:[33,1,1,""],StubFactory:[33,1,1,""]},"com.vmware.esx.settings.defaults.clusters.policies_client.Apply":{ConfiguredPolicySpec:[33,1,1,""],FailureAction:[33,1,1,""],ParallelRemediationAction:[33,1,1,""],get:[33,2,1,""],set:[33,2,1,""]},"com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec":{PreRemediationPowerAction:[33,1,1,""]},"com.vmware.esx.settings.defaults.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[33,3,1,""],POWER_OFF_VMS:[33,3,1,""],SUSPEND_VMS:[33,3,1,""],SUSPEND_VMS_TO_MEMORY:[33,3,1,""]},"com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction":{Action:[33,1,1,""]},"com.vmware.esx.settings.defaults.clusters.policies_client.Apply.FailureAction.Action":{FAIL:[33,3,1,""],RETRY:[33,3,1,""]},"com.vmware.esx.settings.defaults.clusters_client":{StubFactory:[32,1,1,""]},"com.vmware.esx.settings.defaults.hosts":{policies:[36,0,0,"-"],policies_client:[35,0,0,"-"]},"com.vmware.esx.settings.defaults.hosts.policies":{apply_client:[36,0,0,"-"]},"com.vmware.esx.settings.defaults.hosts.policies.apply_client":{Effective:[36,1,1,""],StubFactory:[36,1,1,""]},"com.vmware.esx.settings.defaults.hosts.policies.apply_client.Effective":{EffectivePolicySpec:[36,1,1,""],FailureAction:[36,1,1,""],get:[36,2,1,""]},"com.vmware.esx.settings.defaults.hosts.policies.apply_client.Effective.EffectivePolicySpec":{PreRemediationPowerAction:[36,1,1,""]},"com.vmware.esx.settings.defaults.hosts.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[36,3,1,""],POWER_OFF_VMS:[36,3,1,""],SUSPEND_VMS:[36,3,1,""],SUSPEND_VMS_TO_MEMORY:[36,3,1,""]},"com.vmware.esx.settings.defaults.hosts.policies.apply_client.Effective.FailureAction":{Action:[36,1,1,""]},"com.vmware.esx.settings.defaults.hosts.policies.apply_client.Effective.FailureAction.Action":{FAIL:[36,3,1,""],RETRY:[36,3,1,""]},"com.vmware.esx.settings.defaults.hosts.policies_client":{Apply:[35,1,1,""],StubFactory:[35,1,1,""]},"com.vmware.esx.settings.defaults.hosts.policies_client.Apply":{ConfiguredPolicySpec:[35,1,1,""],FailureAction:[35,1,1,""],get:[35,2,1,""],set:[35,2,1,""]},"com.vmware.esx.settings.defaults.hosts.policies_client.Apply.ConfiguredPolicySpec":{PreRemediationPowerAction:[35,1,1,""]},"com.vmware.esx.settings.defaults.hosts.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[35,3,1,""],POWER_OFF_VMS:[35,3,1,""],SUSPEND_VMS:[35,3,1,""],SUSPEND_VMS_TO_MEMORY:[35,3,1,""]},"com.vmware.esx.settings.defaults.hosts.policies_client.Apply.FailureAction":{Action:[35,1,1,""]},"com.vmware.esx.settings.defaults.hosts.policies_client.Apply.FailureAction.Action":{FAIL:[35,3,1,""],RETRY:[35,3,1,""]},"com.vmware.esx.settings.defaults.hosts_client":{StubFactory:[32,1,1,""]},"com.vmware.esx.settings.defaults_client":{StubFactory:[23,1,1,""]},"com.vmware.esx.settings.depot_content":{add_ons_client:[37,0,0,"-"],base_images_client:[37,0,0,"-"],components_client:[37,0,0,"-"]},"com.vmware.esx.settings.depot_content.add_ons_client":{StubFactory:[37,1,1,""],Versions:[37,1,1,""]},"com.vmware.esx.settings.depot_content.add_ons_client.Versions":{CategoryType:[37,1,1,""],ComponentInfo:[37,1,1,""],Info:[37,1,1,""],RemovedComponentInfo:[37,1,1,""],get:[37,2,1,""]},"com.vmware.esx.settings.depot_content.add_ons_client.Versions.CategoryType":{BUGFIX:[37,3,1,""],ENHANCEMENT:[37,3,1,""],SECURITY:[37,3,1,""]},"com.vmware.esx.settings.depot_content.base_images_client":{StubFactory:[37,1,1,""],Versions:[37,1,1,""]},"com.vmware.esx.settings.depot_content.base_images_client.Versions":{CategoryType:[37,1,1,""],ComponentVersionInfo:[37,1,1,""],Info:[37,1,1,""],get:[37,2,1,""]},"com.vmware.esx.settings.depot_content.base_images_client.Versions.CategoryType":{BUGFIX:[37,3,1,""],ENHANCEMENT:[37,3,1,""],SECURITY:[37,3,1,""]},"com.vmware.esx.settings.depot_content.components_client":{StubFactory:[37,1,1,""],Versions:[37,1,1,""]},"com.vmware.esx.settings.depot_content.components_client.Versions":{CategoryType:[37,1,1,""],Info:[37,1,1,""],UrgencyType:[37,1,1,""],get:[37,2,1,""]},"com.vmware.esx.settings.depot_content.components_client.Versions.CategoryType":{BUGFIX:[37,3,1,""],ENHANCEMENT:[37,3,1,""],GENERAL:[37,3,1,""],INFO:[37,3,1,""],MISC:[37,3,1,""],RECALL:[37,3,1,""],RECALL_FIX:[37,3,1,""],SECURITY:[37,3,1,""]},"com.vmware.esx.settings.depot_content.components_client.Versions.UrgencyType":{CRITICAL:[37,3,1,""],GENERAL:[37,3,1,""],IMPORTANT:[37,3,1,""],LOW:[37,3,1,""],MODERATE:[37,3,1,""]},"com.vmware.esx.settings.depot_content_client":{AddOns:[23,1,1,""],BaseImages:[23,1,1,""],Components:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.esx.settings.depot_content_client.AddOns":{AddOnVersionSummary:[23,1,1,""],CategoryType:[23,1,1,""],FilterSpec:[23,1,1,""],RESOURCE_TYPE:[23,3,1,""],Summary:[23,1,1,""],list:[23,2,1,""]},"com.vmware.esx.settings.depot_content_client.AddOns.CategoryType":{BUGFIX:[23,3,1,""],ENHANCEMENT:[23,3,1,""],SECURITY:[23,3,1,""]},"com.vmware.esx.settings.depot_content_client.BaseImages":{CategoryType:[23,1,1,""],FilterSpec:[23,1,1,""],RESOURCE_TYPE:[23,3,1,""],Summary:[23,1,1,""],list:[23,2,1,""]},"com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType":{BUGFIX:[23,3,1,""],ENHANCEMENT:[23,3,1,""],SECURITY:[23,3,1,""]},"com.vmware.esx.settings.depot_content_client.Components":{CategoryType:[23,1,1,""],ComponentBundleType:[23,1,1,""],ComponentVersionSummary:[23,1,1,""],FilterSpec:[23,1,1,""],RESOURCE_TYPE:[23,3,1,""],Summary:[23,1,1,""],UrgencyType:[23,1,1,""],list:[23,2,1,""]},"com.vmware.esx.settings.depot_content_client.Components.CategoryType":{BUGFIX:[23,3,1,""],ENHANCEMENT:[23,3,1,""],GENERAL:[23,3,1,""],INFO:[23,3,1,""],MISC:[23,3,1,""],RECALL:[23,3,1,""],RECALL_FIX:[23,3,1,""],SECURITY:[23,3,1,""]},"com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType":{ADD_ON:[23,3,1,""],BASE_IMAGE:[23,3,1,""],INDEPENDENT:[23,3,1,""]},"com.vmware.esx.settings.depot_content_client.Components.UrgencyType":{CRITICAL:[23,3,1,""],GENERAL:[23,3,1,""],IMPORTANT:[23,3,1,""],LOW:[23,3,1,""],MODERATE:[23,3,1,""]},"com.vmware.esx.settings.depots":{offline_client:[38,0,0,"-"],online_client:[38,0,0,"-"],umds_client:[38,0,0,"-"]},"com.vmware.esx.settings.depots.offline_client":{Content:[38,1,1,""],StubFactory:[38,1,1,""]},"com.vmware.esx.settings.depots.offline_client.Content":{Info:[38,1,1,""],get:[38,2,1,""]},"com.vmware.esx.settings.depots.online_client":{Content:[38,1,1,""],StubFactory:[38,1,1,""]},"com.vmware.esx.settings.depots.online_client.Content":{Info:[38,1,1,""],get:[38,2,1,""]},"com.vmware.esx.settings.depots.umds_client":{Content:[38,1,1,""],StubFactory:[38,1,1,""]},"com.vmware.esx.settings.depots.umds_client.Content":{Info:[38,1,1,""],get:[38,2,1,""]},"com.vmware.esx.settings.depots_client":{AddonSummary:[23,1,1,""],AddonVersion:[23,1,1,""],AffectedBaselineInfo:[23,1,1,""],AffectedDesiredStateInfo:[23,1,1,""],BaseImageVersion:[23,1,1,""],ComponentSummary:[23,1,1,""],ComponentVersion:[23,1,1,""],HardwareSupportManagerSummary:[23,1,1,""],HardwareSupportPackageSummary:[23,1,1,""],HardwareSupportPackageVersion:[23,1,1,""],MetadataInfo:[23,1,1,""],Offline:[23,1,1,""],Online:[23,1,1,""],SolutionSummary:[23,1,1,""],SolutionVersion:[23,1,1,""],StubFactory:[23,1,1,""],SyncSchedule:[23,1,1,""],Umds:[23,1,1,""],UpdateSummary:[23,1,1,""]},"com.vmware.esx.settings.depots_client.Offline":{"delete":[23,2,1,""],ConnectionSpec:[23,1,1,""],CreateResult:[23,1,1,""],CreateSpec:[23,1,1,""],DeleteResult:[23,1,1,""],DepotExtractInfo:[23,1,1,""],HostCredentials:[23,1,1,""],Info:[23,1,1,""],PrecheckResult:[23,1,1,""],RESOURCE_TYPE:[23,3,1,""],SourceType:[23,1,1,""],Summary:[23,1,1,""],create_from_host_task:[23,2,1,""],create_task:[23,2,1,""],delete_task:[23,2,1,""],get:[23,2,1,""],list:[23,2,1,""]},"com.vmware.esx.settings.depots_client.Offline.ConnectionSpec":{AuthenticationType:[23,1,1,""]},"com.vmware.esx.settings.depots_client.Offline.ConnectionSpec.AuthenticationType":{EXISTING:[23,3,1,""],USERNAME_PASSWORD:[23,3,1,""]},"com.vmware.esx.settings.depots_client.Offline.SourceType":{PULL:[23,3,1,""],PUSH:[23,3,1,""]},"com.vmware.esx.settings.depots_client.Online":{"delete":[23,2,1,""],CreateSpec:[23,1,1,""],DeleteResult:[23,1,1,""],FlushResult:[23,1,1,""],Info:[23,1,1,""],PrecheckResult:[23,1,1,""],RESOURCE_TYPE:[23,3,1,""],Summary:[23,1,1,""],UpdateSpec:[23,1,1,""],create:[23,2,1,""],delete_task:[23,2,1,""],flush_task:[23,2,1,""],get:[23,2,1,""],list:[23,2,1,""],update:[23,2,1,""]},"com.vmware.esx.settings.depots_client.SyncSchedule":{DayOfWeek:[23,1,1,""],Recurrence:[23,1,1,""],Schedule:[23,1,1,""],Spec:[23,1,1,""],get:[23,2,1,""],set:[23,2,1,""]},"com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek":{FRIDAY:[23,3,1,""],MONDAY:[23,3,1,""],SATURDAY:[23,3,1,""],SUNDAY:[23,3,1,""],THURSDAY:[23,3,1,""],TUESDAY:[23,3,1,""],WEDNESDAY:[23,3,1,""]},"com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence":{DAILY:[23,3,1,""],HOURLY:[23,3,1,""],MONTHLY_BY_DAY:[23,3,1,""],WEEKLY:[23,3,1,""]},"com.vmware.esx.settings.depots_client.Umds":{"delete":[23,2,1,""],DeleteResult:[23,1,1,""],Info:[23,1,1,""],PrecheckResult:[23,1,1,""],SetSpec:[23,1,1,""],UpdateSpec:[23,1,1,""],delete_task:[23,2,1,""],get:[23,2,1,""],set:[23,2,1,""],update:[23,2,1,""]},"com.vmware.esx.settings.hardware_support":{managers:[40,0,0,"-"],managers_client:[39,0,0,"-"]},"com.vmware.esx.settings.hardware_support.managers":{packages_client:[40,0,0,"-"]},"com.vmware.esx.settings.hardware_support.managers.packages_client":{StubFactory:[40,1,1,""],Versions:[40,1,1,""]},"com.vmware.esx.settings.hardware_support.managers.packages_client.Versions":{ComponentInfo:[40,1,1,""],FilterSpec:[40,1,1,""],PackageInfo:[40,1,1,""],RemovedComponentInfo:[40,1,1,""],get:[40,2,1,""]},"com.vmware.esx.settings.hardware_support.managers_client":{Packages:[39,1,1,""],StubFactory:[39,1,1,""]},"com.vmware.esx.settings.hardware_support.managers_client.Packages":{FilterSpec:[39,1,1,""],HardwareSupportPackageInfo:[39,1,1,""],list:[39,2,1,""]},"com.vmware.esx.settings.hardware_support_client":{Managers:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.esx.settings.hardware_support_client.Managers":{HardwareSupportManagerInfo:[23,1,1,""],list:[23,2,1,""]},"com.vmware.esx.settings.hosts":{enablement_client:[41,0,0,"-"],policies:[42,0,0,"-"],policies_client:[41,0,0,"-"],software:[43,0,0,"-"],software_client:[41,0,0,"-"]},"com.vmware.esx.settings.hosts.enablement_client":{Software:[41,1,1,""],StubFactory:[41,1,1,""]},"com.vmware.esx.settings.hosts.enablement_client.Software":{CheckResult:[41,1,1,""],CheckSpec:[41,1,1,""],CheckType:[41,1,1,""],EnableSpec:[41,1,1,""],Info:[41,1,1,""],check_task:[41,2,1,""],enable_task:[41,2,1,""],get:[41,2,1,""]},"com.vmware.esx.settings.hosts.enablement_client.Software.CheckType":{SOFTWARE:[41,3,1,""],SOFTWARE_SPECIFICATION_EXISTENCE:[41,3,1,""],STATELESSNESS:[41,3,1,""],VERSION:[41,3,1,""],VSAN_WITNESS_ELIGIBILITY:[41,3,1,""],VUM_REMEDIATION:[41,3,1,""]},"com.vmware.esx.settings.hosts.policies":{apply_client:[42,0,0,"-"]},"com.vmware.esx.settings.hosts.policies.apply_client":{Effective:[42,1,1,""],StubFactory:[42,1,1,""]},"com.vmware.esx.settings.hosts.policies.apply_client.Effective":{EffectivePolicySpec:[42,1,1,""],FailureAction:[42,1,1,""],get:[42,2,1,""]},"com.vmware.esx.settings.hosts.policies.apply_client.Effective.EffectivePolicySpec":{PreRemediationPowerAction:[42,1,1,""]},"com.vmware.esx.settings.hosts.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[42,3,1,""],POWER_OFF_VMS:[42,3,1,""],SUSPEND_VMS:[42,3,1,""],SUSPEND_VMS_TO_MEMORY:[42,3,1,""]},"com.vmware.esx.settings.hosts.policies.apply_client.Effective.FailureAction":{Action:[42,1,1,""]},"com.vmware.esx.settings.hosts.policies.apply_client.Effective.FailureAction.Action":{FAIL:[42,3,1,""],RETRY:[42,3,1,""]},"com.vmware.esx.settings.hosts.policies_client":{Apply:[41,1,1,""],StubFactory:[41,1,1,""]},"com.vmware.esx.settings.hosts.policies_client.Apply":{ConfiguredPolicySpec:[41,1,1,""],FailureAction:[41,1,1,""],get:[41,2,1,""],set:[41,2,1,""]},"com.vmware.esx.settings.hosts.policies_client.Apply.ConfiguredPolicySpec":{PreRemediationPowerAction:[41,1,1,""]},"com.vmware.esx.settings.hosts.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction":{DO_NOT_CHANGE_VMS_POWER_STATE:[41,3,1,""],POWER_OFF_VMS:[41,3,1,""],SUSPEND_VMS:[41,3,1,""],SUSPEND_VMS_TO_MEMORY:[41,3,1,""]},"com.vmware.esx.settings.hosts.policies_client.Apply.FailureAction":{Action:[41,1,1,""]},"com.vmware.esx.settings.hosts.policies_client.Apply.FailureAction.Action":{FAIL:[41,3,1,""],RETRY:[41,3,1,""]},"com.vmware.esx.settings.hosts.software":{drafts:[44,0,0,"-"],drafts_client:[43,0,0,"-"],reports_client:[43,0,0,"-"]},"com.vmware.esx.settings.hosts.software.drafts":{software_client:[44,0,0,"-"]},"com.vmware.esx.settings.hosts.software.drafts.software_client":{AddOn:[44,1,1,""],BaseImage:[44,1,1,""],Components:[44,1,1,""],EffectiveComponents:[44,1,1,""],StubFactory:[44,1,1,""]},"com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn":{"delete":[44,2,1,""],RESOURCE_TYPE:[44,3,1,""],get:[44,2,1,""],set:[44,2,1,""]},"com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage":{RESOURCE_TYPE:[44,3,1,""],get:[44,2,1,""],set:[44,2,1,""]},"com.vmware.esx.settings.hosts.software.drafts.software_client.Components":{"delete":[44,2,1,""],RESOURCE_TYPE:[44,3,1,""],UpdateSpec:[44,1,1,""],get:[44,2,1,""],list:[44,2,1,""],set:[44,2,1,""],update:[44,2,1,""]},"com.vmware.esx.settings.hosts.software.drafts.software_client.EffectiveComponents":{list:[44,2,1,""]},"com.vmware.esx.settings.hosts.software.drafts_client":{StubFactory:[43,1,1,""]},"com.vmware.esx.settings.hosts.software.reports_client":{ApplyImpact:[43,1,1,""],LastApplyResult:[43,1,1,""],LastCheckResult:[43,1,1,""],StubFactory:[43,1,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact":{HostImpact:[43,1,1,""],Impact:[43,1,1,""],get:[43,2,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult":{ApplyResult:[43,1,1,""],ApplyStatus:[43,1,1,""],get:[43,2,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus":{Status:[43,1,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status":{ERROR:[43,3,1,""],OK:[43,3,1,""],SKIPPED:[43,3,1,""],TIMED_OUT:[43,3,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult":{CheckInfo:[43,1,1,""],CheckIssue:[43,1,1,""],CheckResult:[43,1,1,""],CheckStatus:[43,1,1,""],EntityCheckResult:[43,1,1,""],Status:[43,1,1,""],get:[43,2,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult":{EntityType:[43,1,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType":{HOST:[43,3,1,""]},"com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status":{ERROR:[43,3,1,""],OK:[43,3,1,""],TIMEOUT:[43,3,1,""],WARNING:[43,3,1,""]},"com.vmware.esx.settings.hosts.software_client":{AddOn:[41,1,1,""],BaseImage:[41,1,1,""],Commits:[41,1,1,""],Compliance:[41,1,1,""],Components:[41,1,1,""],Drafts:[41,1,1,""],EffectiveComponents:[41,1,1,""],Recommendations:[41,1,1,""],Solutions:[41,1,1,""],StubFactory:[41,1,1,""]},"com.vmware.esx.settings.hosts.software_client.AddOn":{RESOURCE_TYPE:[41,3,1,""],get:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.BaseImage":{RESOURCE_TYPE:[41,3,1,""],get:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Commits":{ApplyStatusType:[41,1,1,""],Info:[41,1,1,""],RESOURCE_TYPE:[41,3,1,""],get:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Commits.ApplyStatusType":{APPLIED:[41,3,1,""],NOT_APPLIED:[41,3,1,""]},"com.vmware.esx.settings.hosts.software_client.Compliance":{get:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Components":{RESOURCE_TYPE:[41,3,1,""],get:[41,2,1,""],list:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Drafts":{"delete":[41,2,1,""],CommitSpec:[41,1,1,""],FilterSpec:[41,1,1,""],ImportSpec:[41,1,1,""],Info:[41,1,1,""],Metadata:[41,1,1,""],RESOURCE_TYPE:[41,3,1,""],SourceType:[41,1,1,""],StatusType:[41,1,1,""],Summary:[41,1,1,""],ValidateResult:[41,1,1,""],commit_task:[41,2,1,""],create:[41,2,1,""],get:[41,2,1,""],import_software_spec:[41,2,1,""],list:[41,2,1,""],scan_task:[41,2,1,""],validate_task:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Drafts.SourceType":{CURRENT_SERIES_RECOMMENDATION:[41,3,1,""],JSON_STRING:[41,3,1,""],LATEST_RECOMMENDATION:[41,3,1,""],PULL:[41,3,1,""],PUSH:[41,3,1,""]},"com.vmware.esx.settings.hosts.software_client.Drafts.StatusType":{INVALID:[41,3,1,""],VALID:[41,3,1,""]},"com.vmware.esx.settings.hosts.software_client.EffectiveComponents":{list:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Recommendations":{ExplanationDetails:[41,1,1,""],Info:[41,1,1,""],generate_task:[41,2,1,""],get:[41,2,1,""]},"com.vmware.esx.settings.hosts.software_client.Solutions":{RESOURCE_TYPE:[41,3,1,""],delete_task:[41,2,1,""],get:[41,2,1,""],list:[41,2,1,""],set_task:[41,2,1,""]},"com.vmware.esx.settings.hosts_client":{Configuration:[23,1,1,""],DepotOverrides:[23,1,1,""],Software:[23,1,1,""],StubFactory:[23,1,1,""]},"com.vmware.esx.settings.hosts_client.Configuration":{ExtractResult:[23,1,1,""],extract:[23,2,1,""]},"com.vmware.esx.settings.hosts_client.DepotOverrides":{Depot:[23,1,1,""],Info:[23,1,1,""],add:[23,2,1,""],get:[23,2,1,""],remove:[23,2,1,""]},"com.vmware.esx.settings.hosts_client.Software":{"export":[23,2,1,""],ApplyResult:[23,1,1,""],ApplySpec:[23,1,1,""],ApplyStatus:[23,1,1,""],CheckInfo:[23,1,1,""],CheckIssue:[23,1,1,""],CheckResult:[23,1,1,""],CheckSpec:[23,1,1,""],CheckStatus:[23,1,1,""],EntityCheckResult:[23,1,1,""],ExportSpec:[23,1,1,""],ExportType:[23,1,1,""],StageResult:[23,1,1,""],StageSpec:[23,1,1,""],StageStatus:[23,1,1,""],Status:[23,1,1,""],apply_task:[23,2,1,""],check_task:[23,2,1,""],get:[23,2,1,""],scan_task:[23,2,1,""],stage_task:[23,2,1,""]},"com.vmware.esx.settings.hosts_client.Software.ApplyStatus":{Status:[23,1,1,""]},"com.vmware.esx.settings.hosts_client.Software.ApplyStatus.Status":{ERROR:[23,3,1,""],OK:[23,3,1,""],RETRY_PENDING:[23,3,1,""],RUNNING:[23,3,1,""],SKIPPED:[23,3,1,""],TIMED_OUT:[23,3,1,""]},"com.vmware.esx.settings.hosts_client.Software.EntityCheckResult":{EntityType:[23,1,1,""]},"com.vmware.esx.settings.hosts_client.Software.EntityCheckResult.EntityType":{HOST:[23,3,1,""]},"com.vmware.esx.settings.hosts_client.Software.ExportType":{ISO_IMAGE:[23,3,1,""],OFFLINE_BUNDLE:[23,3,1,""],SOFTWARE_SPEC:[23,3,1,""]},"com.vmware.esx.settings.hosts_client.Software.StageStatus":{Status:[23,1,1,""]},"com.vmware.esx.settings.hosts_client.Software.StageStatus.Status":{ERROR:[23,3,1,""],OK:[23,3,1,""],RETRY_PENDING:[23,3,1,""],RUNNING:[23,3,1,""],SKIPPED:[23,3,1,""],TIMED_OUT:[23,3,1,""]},"com.vmware.esx.settings.hosts_client.Software.Status":{ERROR:[23,3,1,""],OK:[23,3,1,""],RETRY:[23,3,1,""],TIMEOUT:[23,3,1,""],WARNING:[23,3,1,""]},"com.vmware.esx.settings_client":{AddOnCompliance:[20,1,1,""],AddOnDetails:[20,1,1,""],AddOnInfo:[20,1,1,""],AddOnSpec:[20,1,1,""],BaseImageCompliance:[20,1,1,""],BaseImageDetails:[20,1,1,""],BaseImageInfo:[20,1,1,""],BaseImageSpec:[20,1,1,""],CheckDescription:[20,1,1,""],CheckError:[20,1,1,""],CheckStatus:[20,1,1,""],ClusterCompliance:[20,1,1,""],ComplianceImpact:[20,1,1,""],ComplianceStatus:[20,1,1,""],ComponentCompliance:[20,1,1,""],ComponentDetails:[20,1,1,""],ComponentInfo:[20,1,1,""],ComponentOverrideInfo:[20,1,1,""],ComponentSource:[20,1,1,""],DataProcessingUnitCompliance:[20,1,1,""],DataProcessingUnitInfo:[20,1,1,""],DataProcessingUnitsCompliance:[20,1,1,""],Depots:[20,1,1,""],EffectiveComponentDetails:[20,1,1,""],EffectiveComponentInfo:[20,1,1,""],HardwareModuleClass:[20,1,1,""],HardwareModuleDetails:[20,1,1,""],HardwareModuleFirmwareCompliance:[20,1,1,""],HardwareModuleFirmwareInfo:[20,1,1,""],HardwareSupportInfo:[20,1,1,""],HardwareSupportPackageCompliance:[20,1,1,""],HardwareSupportPackageInfo:[20,1,1,""],HardwareSupportPackageSpec:[20,1,1,""],HardwareSupportSpec:[20,1,1,""],HostCompliance:[20,1,1,""],HostInfo:[20,1,1,""],Notification:[20,1,1,""],Notifications:[20,1,1,""],SoftwareInfo:[20,1,1,""],SoftwareSpec:[20,1,1,""],SolutionCompliance:[20,1,1,""],SolutionComponentDetails:[20,1,1,""],SolutionComponentSpec:[20,1,1,""],SolutionDetails:[20,1,1,""],SolutionInfo:[20,1,1,""],SolutionSpec:[20,1,1,""],StageStatus:[20,1,1,""],Status:[20,1,1,""],StatusInfo:[20,1,1,""],StubFactory:[20,1,1,""],TaskInfo:[20,1,1,""]},"com.vmware.esx.settings_client.ComplianceImpact":{MAINTENANCE_MODE_REQUIRED:[20,3,1,""],NO_IMPACT:[20,3,1,""],PARTIAL_MAINTENANCE_MODE_REQUIRED:[20,3,1,""],REBOOT_REQUIRED:[20,3,1,""],UNKNOWN:[20,3,1,""]},"com.vmware.esx.settings_client.ComplianceStatus":{COMPLIANT:[20,3,1,""],INCOMPATIBLE:[20,3,1,""],NON_COMPLIANT:[20,3,1,""],UNAVAILABLE:[20,3,1,""]},"com.vmware.esx.settings_client.ComponentSource":{ADD_ON:[20,3,1,""],BASE_IMAGE:[20,3,1,""],HARDWARE_SUPPORT_PACKAGE:[20,3,1,""],SOLUTION:[20,3,1,""],USER:[20,3,1,""]},"com.vmware.esx.settings_client.Depots":{sync_task:[20,2,1,""]},"com.vmware.esx.settings_client.HardwareModuleClass":{OTHER:[20,3,1,""],PCI_DEVICE:[20,3,1,""],SYSTEM_BIOS:[20,3,1,""]},"com.vmware.esx.settings_client.Notification":{Type:[20,1,1,""]},"com.vmware.esx.settings_client.Notification.Type":{ERROR:[20,3,1,""],INFO:[20,3,1,""],WARNING:[20,3,1,""]},"com.vmware.esx.settings_client.StageStatus":{NOT_STAGED:[20,3,1,""],STAGED:[20,3,1,""]},"com.vmware.esx.settings_client.Status":{ERROR:[20,3,1,""],OK:[20,3,1,""],RETRY:[20,3,1,""],TIMEOUT:[20,3,1,""],WARNING:[20,3,1,""]},"com.vmware.oauth2":{errors_client:[45,0,0,"-"]},"com.vmware.oauth2.errors_client":{Error:[45,4,1,""],InvalidGrant:[45,4,1,""],InvalidRequest:[45,4,1,""],InvalidScope:[45,4,1,""],StubFactory:[45,1,1,""]},"com.vmware.oauth2.errors_client.Error":{Type:[45,1,1,""]},"com.vmware.oauth2.errors_client.Error.Type":{invalid_grant:[45,3,1,""],invalid_request:[45,3,1,""],invalid_scope:[45,3,1,""]},"com.vmware.oauth2_client":{Constants:[1,1,1,""],StubFactory:[1,1,1,""],TokenInfo:[1,1,1,""]},"com.vmware.oauth2_client.Constants":{ACCESS_TOKEN_TYPE:[1,3,1,""],ID_TOKEN_TYPE:[1,3,1,""],REFRESH_TOKEN_TYPE:[1,3,1,""],SAML2_TOKEN_TYPE:[1,3,1,""],TOKEN_EXCHANGE_GRANT:[1,3,1,""]},"com.vmware.oauth2_client.TokenInfo":{BEARER_TOKEN_METHOD_TYPE:[1,3,1,""]},"com.vmware.vapi":{metadata:[47,0,0,"-"],metadata_client:[46,0,0,"-"],std:[51,0,0,"-"],std_client:[46,0,0,"-"]},"com.vmware.vapi.metadata":{authentication:[48,0,0,"-"],authentication_client:[47,0,0,"-"],cli_client:[47,0,0,"-"],metamodel:[49,0,0,"-"],metamodel_client:[47,0,0,"-"],privilege:[50,0,0,"-"],privilege_client:[47,0,0,"-"]},"com.vmware.vapi.metadata.authentication":{service_client:[48,0,0,"-"]},"com.vmware.vapi.metadata.authentication.service_client":{Operation:[48,1,1,""],StubFactory:[48,1,1,""]},"com.vmware.vapi.metadata.authentication.service_client.Operation":{RESOURCE_TYPE:[48,3,1,""],get:[48,2,1,""],list:[48,2,1,""]},"com.vmware.vapi.metadata.authentication_client":{AuthenticationInfo:[47,1,1,""],Component:[47,1,1,""],ComponentData:[47,1,1,""],ComponentInfo:[47,1,1,""],OperationInfo:[47,1,1,""],Package:[47,1,1,""],PackageInfo:[47,1,1,""],Service:[47,1,1,""],ServiceInfo:[47,1,1,""],StubFactory:[47,1,1,""]},"com.vmware.vapi.metadata.authentication_client.AuthenticationInfo":{SchemeType:[47,1,1,""]},"com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType":{SESSIONLESS:[47,3,1,""],SESSION_AWARE:[47,3,1,""]},"com.vmware.vapi.metadata.authentication_client.Component":{RESOURCE_TYPE:[47,3,1,""],fingerprint:[47,2,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.authentication_client.Package":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.authentication_client.Service":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.cli_client":{Command:[47,1,1,""],Namespace:[47,1,1,""],StubFactory:[47,1,1,""]},"com.vmware.vapi.metadata.cli_client.Command":{FormatterType:[47,1,1,""],GenericType:[47,1,1,""],Identity:[47,1,1,""],Info:[47,1,1,""],OptionInfo:[47,1,1,""],OutputFieldInfo:[47,1,1,""],OutputInfo:[47,1,1,""],fingerprint:[47,2,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.cli_client.Command.FormatterType":{CSV:[47,3,1,""],HTML:[47,3,1,""],JSON:[47,3,1,""],SIMPLE:[47,3,1,""],TABLE:[47,3,1,""],XML:[47,3,1,""]},"com.vmware.vapi.metadata.cli_client.Command.GenericType":{LIST:[47,3,1,""],LIST_OPTIONAL:[47,3,1,""],NONE:[47,3,1,""],OPTIONAL:[47,3,1,""],OPTIONAL_LIST:[47,3,1,""]},"com.vmware.vapi.metadata.cli_client.Namespace":{Identity:[47,1,1,""],Info:[47,1,1,""],fingerprint:[47,2,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel":{resource_client:[49,0,0,"-"],service_client:[49,0,0,"-"]},"com.vmware.vapi.metadata.metamodel.resource_client":{Model:[49,1,1,""],StubFactory:[49,1,1,""]},"com.vmware.vapi.metadata.metamodel.resource_client.Model":{list:[49,2,1,""]},"com.vmware.vapi.metadata.metamodel.service_client":{Operation:[49,1,1,""],StubFactory:[49,1,1,""]},"com.vmware.vapi.metadata.metamodel.service_client.Operation":{RESOURCE_TYPE:[49,3,1,""],get:[49,2,1,""],list:[49,2,1,""]},"com.vmware.vapi.metadata.metamodel_client":{Component:[47,1,1,""],ComponentData:[47,1,1,""],ComponentInfo:[47,1,1,""],ConstantInfo:[47,1,1,""],ConstantValue:[47,1,1,""],ElementMap:[47,1,1,""],ElementValue:[47,1,1,""],Enumeration:[47,1,1,""],EnumerationInfo:[47,1,1,""],EnumerationValueInfo:[47,1,1,""],ErrorInfo:[47,1,1,""],FieldInfo:[47,1,1,""],GenericInstantiation:[47,1,1,""],MetadataIdentifier:[47,1,1,""],OperationInfo:[47,1,1,""],OperationResultInfo:[47,1,1,""],Package:[47,1,1,""],PackageInfo:[47,1,1,""],PrimitiveValue:[47,1,1,""],Resource:[47,1,1,""],Service:[47,1,1,""],ServiceInfo:[47,1,1,""],Structure:[47,1,1,""],StructureInfo:[47,1,1,""],StubFactory:[47,1,1,""],Type:[47,1,1,""],UserDefinedType:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.Component":{RESOURCE_TYPE:[47,3,1,""],fingerprint:[47,2,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel_client.ConstantValue":{Category:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category":{LIST:[47,3,1,""],PRIMITIVE:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.ElementValue":{Type:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.ElementValue.Type":{LONG:[47,3,1,""],STRING:[47,3,1,""],STRING_LIST:[47,3,1,""],STRUCTURE_REFERENCE:[47,3,1,""],STRUCTURE_REFERENCE_LIST:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.Enumeration":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel_client.GenericInstantiation":{GenericType:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType":{LIST:[47,3,1,""],MAP:[47,3,1,""],OPTIONAL:[47,3,1,""],SET:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier":{CANONICAL_NAME:[47,3,1,""],COMPONENT:[47,3,1,""],CREATE:[47,3,1,""],CRUD:[47,3,1,""],HAS_FIELDS_OF:[47,3,1,""],INCLUDABLE:[47,3,1,""],INCLUDE:[47,3,1,""],IS_ONE_OF:[47,3,1,""],MODEL:[47,3,1,""],READ:[47,3,1,""],RESOURCE:[47,3,1,""],UNION_CASE:[47,3,1,""],UNION_TAG:[47,3,1,""],UPDATE:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.Package":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel_client.PrimitiveValue":{Type:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type":{BOOLEAN:[47,3,1,""],DOUBLE:[47,3,1,""],LONG:[47,3,1,""],STRING:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.Resource":{RESOURCE_TYPE:[47,3,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel_client.Service":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel_client.Structure":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.metamodel_client.StructureInfo":{Type:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type":{ERROR:[47,3,1,""],STRUCTURE:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.Type":{BuiltinType:[47,1,1,""],Category:[47,1,1,""]},"com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType":{ANY_ERROR:[47,3,1,""],BINARY:[47,3,1,""],BOOLEAN:[47,3,1,""],DATE_TIME:[47,3,1,""],DOUBLE:[47,3,1,""],DYNAMIC_STRUCTURE:[47,3,1,""],ID:[47,3,1,""],LONG:[47,3,1,""],OPAQUE:[47,3,1,""],SECRET:[47,3,1,""],STRING:[47,3,1,""],URI:[47,3,1,""],VOID:[47,3,1,""]},"com.vmware.vapi.metadata.metamodel_client.Type.Category":{BUILTIN:[47,3,1,""],GENERIC:[47,3,1,""],USER_DEFINED:[47,3,1,""]},"com.vmware.vapi.metadata.privilege":{service_client:[50,0,0,"-"]},"com.vmware.vapi.metadata.privilege.service_client":{Operation:[50,1,1,""],StubFactory:[50,1,1,""]},"com.vmware.vapi.metadata.privilege.service_client.Operation":{RESOURCE_TYPE:[50,3,1,""],get:[50,2,1,""],list:[50,2,1,""]},"com.vmware.vapi.metadata.privilege_client":{Component:[47,1,1,""],ComponentData:[47,1,1,""],ComponentInfo:[47,1,1,""],OperationInfo:[47,1,1,""],Package:[47,1,1,""],PackageInfo:[47,1,1,""],PrivilegeInfo:[47,1,1,""],Service:[47,1,1,""],ServiceInfo:[47,1,1,""],StubFactory:[47,1,1,""]},"com.vmware.vapi.metadata.privilege_client.Component":{RESOURCE_TYPE:[47,3,1,""],fingerprint:[47,2,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.privilege_client.Package":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata.privilege_client.Service":{RESOURCE_TYPE:[47,3,1,""],get:[47,2,1,""],list:[47,2,1,""]},"com.vmware.vapi.metadata_client":{SourceCreateSpec:[46,1,1,""],SourceInfo:[46,1,1,""],SourceType:[46,1,1,""],StubFactory:[46,1,1,""]},"com.vmware.vapi.metadata_client.SourceType":{FILE:[46,3,1,""],REMOTE:[46,3,1,""]},"com.vmware.vapi.std":{errors_client:[51,0,0,"-"],routing_client:[51,0,0,"-"]},"com.vmware.vapi.std.errors_client":{AlreadyExists:[51,4,1,""],AlreadyInDesiredState:[51,4,1,""],ArgumentLocations:[51,1,1,""],Canceled:[51,4,1,""],ConcurrentChange:[51,4,1,""],Error:[51,4,1,""],FeatureInUse:[51,4,1,""],FileLocations:[51,1,1,""],InternalServerError:[51,4,1,""],InvalidArgument:[51,4,1,""],InvalidElementConfiguration:[51,4,1,""],InvalidElementType:[51,4,1,""],InvalidRequest:[51,4,1,""],NotAllowedInCurrentState:[51,4,1,""],NotFound:[51,4,1,""],OperationNotFound:[51,4,1,""],ResourceBusy:[51,4,1,""],ResourceInUse:[51,4,1,""],ResourceInaccessible:[51,4,1,""],ServiceUnavailable:[51,4,1,""],StubFactory:[51,1,1,""],TimedOut:[51,4,1,""],TransientIndication:[51,1,1,""],UnableToAllocateResource:[51,4,1,""],Unauthenticated:[51,4,1,""],Unauthorized:[51,4,1,""],UnexpectedInput:[51,4,1,""],Unsupported:[51,4,1,""],UnverifiedPeer:[51,4,1,""]},"com.vmware.vapi.std.errors_client.Error":{Type:[51,1,1,""]},"com.vmware.vapi.std.errors_client.Error.Type":{ALREADY_EXISTS:[51,3,1,""],ALREADY_IN_DESIRED_STATE:[51,3,1,""],CANCELED:[51,3,1,""],CONCURRENT_CHANGE:[51,3,1,""],ERROR:[51,3,1,""],FEATURE_IN_USE:[51,3,1,""],INTERNAL_SERVER_ERROR:[51,3,1,""],INVALID_ARGUMENT:[51,3,1,""],INVALID_ELEMENT_CONFIGURATION:[51,3,1,""],INVALID_ELEMENT_TYPE:[51,3,1,""],INVALID_REQUEST:[51,3,1,""],NOT_ALLOWED_IN_CURRENT_STATE:[51,3,1,""],NOT_FOUND:[51,3,1,""],OPERATION_NOT_FOUND:[51,3,1,""],RESOURCE_BUSY:[51,3,1,""],RESOURCE_INACCESSIBLE:[51,3,1,""],RESOURCE_IN_USE:[51,3,1,""],SERVICE_UNAVAILABLE:[51,3,1,""],TIMED_OUT:[51,3,1,""],UNABLE_TO_ALLOCATE_RESOURCE:[51,3,1,""],UNAUTHENTICATED:[51,3,1,""],UNAUTHORIZED:[51,3,1,""],UNEXPECTED_INPUT:[51,3,1,""],UNSUPPORTED:[51,3,1,""],UNVERIFIED_PEER:[51,3,1,""]},"com.vmware.vapi.std.routing_client":{StubFactory:[51,1,1,""]},"com.vmware.vapi.std_client":{AuthenticationScheme:[46,1,1,""],DynamicID:[46,1,1,""],LocalizableMessage:[46,1,1,""],LocalizationParam:[46,1,1,""],NestedLocalizableMessage:[46,1,1,""],StubFactory:[46,1,1,""]},"com.vmware.vapi.std_client.AuthenticationScheme":{NO_AUTHENTICATION:[46,3,1,""],OAUTH_ACCESS_TOKEN:[46,3,1,""],SAML_BEARER_TOKEN:[46,3,1,""],SAML_HOK_TOKEN:[46,3,1,""],SESSION_ID:[46,3,1,""],USER_PASSWORD:[46,3,1,""]},"com.vmware.vapi.std_client.LocalizationParam":{DateTimeFormat:[46,1,1,""]},"com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat":{FULL_DATE:[46,3,1,""],FULL_DATE_TIME:[46,3,1,""],FULL_TIME:[46,3,1,""],LONG_DATE:[46,3,1,""],LONG_DATE_TIME:[46,3,1,""],LONG_TIME:[46,3,1,""],MED_DATE:[46,3,1,""],MED_DATE_TIME:[46,3,1,""],MED_TIME:[46,3,1,""],SHORT_DATE:[46,3,1,""],SHORT_DATE_TIME:[46,3,1,""],SHORT_TIME:[46,3,1,""]},"com.vmware.vapi_client":{StubFactory:[1,1,1,""]},"com.vmware.vcenter":{authentication_client:[52,0,0,"-"],authorization:[53,0,0,"-"],authorization_client:[52,0,0,"-"],certificate_management:[54,0,0,"-"],certificate_management_client:[52,0,0,"-"],compute:[55,0,0,"-"],compute_client:[52,0,0,"-"],confidential_computing:[61,0,0,"-"],consumption_domains:[62,0,0,"-"],consumption_domains_client:[52,0,0,"-"],content:[64,0,0,"-"],crypto_manager:[66,0,0,"-"],crypto_manager_client:[52,0,0,"-"],datastore_client:[52,0,0,"-"],deployment:[68,0,0,"-"],deployment_client:[52,0,0,"-"],guest_client:[52,0,0,"-"],host:[71,0,0,"-"],host_client:[52,0,0,"-"],hvc:[72,0,0,"-"],hvc_client:[52,0,0,"-"],identity:[73,0,0,"-"],identity_client:[52,0,0,"-"],inventory_client:[52,0,0,"-"],iso_client:[52,0,0,"-"],lcm:[75,0,0,"-"],lcm_client:[52,0,0,"-"],namespace_management:[77,0,0,"-"],namespace_management_client:[52,0,0,"-"],namespaces:[82,0,0,"-"],namespaces_client:[52,0,0,"-"],ovf_client:[52,0,0,"-"],services_client:[52,0,0,"-"],storage:[83,0,0,"-"],storage_client:[52,0,0,"-"],system_config:[85,0,0,"-"],system_config_client:[52,0,0,"-"],tagging_client:[52,0,0,"-"],tokenservice_client:[52,0,0,"-"],topology_client:[52,0,0,"-"],trusted_infrastructure:[87,0,0,"-"],trusted_infrastructure_client:[52,0,0,"-"],vcha:[96,0,0,"-"],vcha_client:[52,0,0,"-"],vm:[97,0,0,"-"],vm_client:[52,0,0,"-"],vm_template:[101,0,0,"-"],vm_template_client:[52,0,0,"-"]},"com.vmware.vcenter.authentication_client":{StubFactory:[52,1,1,""],Token:[52,1,1,""]},"com.vmware.vcenter.authentication_client.Token":{IssueSpec:[52,1,1,""],issue:[52,2,1,""]},"com.vmware.vcenter.authorization":{privilege_checks_client:[53,0,0,"-"]},"com.vmware.vcenter.authorization.privilege_checks_client":{Latest:[53,1,1,""],StubFactory:[53,1,1,""]},"com.vmware.vcenter.authorization.privilege_checks_client.Latest":{get:[53,2,1,""]},"com.vmware.vcenter.authorization_client":{PrivilegeChecks:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.authorization_client.PrivilegeChecks":{FilterSpec:[52,1,1,""],Info:[52,1,1,""],IterationSpec:[52,1,1,""],ListResult:[52,1,1,""],Principal:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.certificate_management":{vcenter_client:[54,0,0,"-"]},"com.vmware.vcenter.certificate_management.vcenter_client":{SigningCertificate:[54,1,1,""],StubFactory:[54,1,1,""],Tls:[54,1,1,""],TlsCsr:[54,1,1,""],TrustedRootChains:[54,1,1,""],VmcaRoot:[54,1,1,""]},"com.vmware.vcenter.certificate_management.vcenter_client.SigningCertificate":{Info:[54,1,1,""],SetSpec:[54,1,1,""],get:[54,2,1,""],refresh:[54,2,1,""],set:[54,2,1,""]},"com.vmware.vcenter.certificate_management.vcenter_client.Tls":{Info:[54,1,1,""],ReplaceSpec:[54,1,1,""],Spec:[54,1,1,""],get:[54,2,1,""],renew:[54,2,1,""],replace_vmca_signed:[54,2,1,""],set:[54,2,1,""]},"com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr":{Info:[54,1,1,""],Spec:[54,1,1,""],create:[54,2,1,""]},"com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains":{"delete":[54,2,1,""],CreateSpec:[54,1,1,""],Info:[54,1,1,""],Summary:[54,1,1,""],create:[54,2,1,""],get:[54,2,1,""],list:[54,2,1,""]},"com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot":{CreateSpec:[54,1,1,""],create:[54,2,1,""]},"com.vmware.vcenter.certificate_management_client":{StubFactory:[52,1,1,""],X509CertChain:[52,1,1,""]},"com.vmware.vcenter.compute":{policies:[56,0,0,"-"],policies_client:[55,0,0,"-"]},"com.vmware.vcenter.compute.policies":{capabilities:[57,0,0,"-"],capabilities_client:[56,0,0,"-"]},"com.vmware.vcenter.compute.policies.capabilities":{cluster_scale_in_ignore_vm_capabilities_client:[57,0,0,"-"],disable_drs_vmotion_client:[57,0,0,"-"],vm:[58,0,0,"-"],vm_host_affinity_client:[57,0,0,"-"],vm_host_anti_affinity_client:[57,0,0,"-"],vm_vm_affinity_client:[57,0,0,"-"],vm_vm_anti_affinity_client:[57,0,0,"-"]},"com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client":{CreateSpec:[57,1,1,""],Info:[57,1,1,""],StubFactory:[57,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.CreateSpec":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client.Info":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client":{CreateSpec:[57,1,1,""],Info:[57,1,1,""],StubFactory:[57,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.CreateSpec":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client.Info":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm":{evacuation:[59,0,0,"-"],evacuation_client:[58,0,0,"-"],placement:[60,0,0,"-"],placement_client:[58,0,0,"-"]},"com.vmware.vcenter.compute.policies.capabilities.vm.evacuation":{vmotion_client:[59,0,0,"-"]},"com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client":{CreateSpec:[59,1,1,""],Info:[59,1,1,""],StubFactory:[59,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec":{capability:[59,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info":{capability:[59,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.evacuation_client":{StubFactory:[58,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.placement":{anti_affinity_with_vcls_client:[60,0,0,"-"]},"com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client":{CreateSpec:[60,1,1,""],Info:[60,1,1,""],StubFactory:[60,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client.CreateSpec":{capability:[60,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client.Info":{capability:[60,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm.placement_client":{StubFactory:[58,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client":{CreateSpec:[57,1,1,""],Info:[57,1,1,""],StubFactory:[57,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.CreateSpec":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client.Info":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client":{CreateSpec:[57,1,1,""],Info:[57,1,1,""],StubFactory:[57,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.CreateSpec":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client.Info":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client":{CreateSpec:[57,1,1,""],Info:[57,1,1,""],StubFactory:[57,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.CreateSpec":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client.Info":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client":{CreateSpec:[57,1,1,""],Info:[57,1,1,""],StubFactory:[57,1,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.CreateSpec":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client.Info":{capability:[57,5,1,""]},"com.vmware.vcenter.compute.policies.capabilities_client":{StubFactory:[56,1,1,""]},"com.vmware.vcenter.compute.policies_client":{Capabilities:[55,1,1,""],CreateSpec:[55,1,1,""],Info:[55,1,1,""],ObjectCompliance:[55,1,1,""],Status:[55,1,1,""],StubFactory:[55,1,1,""],TagUsage:[55,1,1,""]},"com.vmware.vcenter.compute.policies_client.Capabilities":{Info:[55,1,1,""],RESOURCE_TYPE:[55,3,1,""],Summary:[55,1,1,""],get:[55,2,1,""],list:[55,2,1,""]},"com.vmware.vcenter.compute.policies_client.CreateSpec":{capability:[55,5,1,""]},"com.vmware.vcenter.compute.policies_client.Info":{capability:[55,5,1,""]},"com.vmware.vcenter.compute.policies_client.ObjectCompliance":{COMPLIANT:[55,3,1,""],NOT_APPLICABLE:[55,3,1,""],NOT_COMPLIANT:[55,3,1,""],UNKNOWN:[55,3,1,""]},"com.vmware.vcenter.compute.policies_client.TagUsage":{FilterSpec:[55,1,1,""],Summary:[55,1,1,""],list:[55,2,1,""]},"com.vmware.vcenter.compute_client":{Policies:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.compute_client.Policies":{"delete":[52,2,1,""],RESOURCE_TYPE:[52,3,1,""],Summary:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""]},"com.vmware.vcenter.confidential_computing":{sgx_client:[61,0,0,"-"]},"com.vmware.vcenter.confidential_computing.sgx_client":{Hosts:[61,1,1,""],StubFactory:[61,1,1,""]},"com.vmware.vcenter.confidential_computing.sgx_client.Hosts":{RegisterSpec:[61,1,1,""],register_task:[61,2,1,""]},"com.vmware.vcenter.consumption_domains":{zone_associations_client:[62,0,0,"-"],zones:[63,0,0,"-"]},"com.vmware.vcenter.consumption_domains.zone_associations_client":{Cluster:[62,1,1,""],StubFactory:[62,1,1,""]},"com.vmware.vcenter.consumption_domains.zone_associations_client.Cluster":{FilterSpec:[62,1,1,""],ListItem:[62,1,1,""],ListResult:[62,1,1,""],list:[62,2,1,""]},"com.vmware.vcenter.consumption_domains.zones":{cluster_client:[63,0,0,"-"]},"com.vmware.vcenter.consumption_domains.zones.cluster_client":{Associations:[63,1,1,""],StubFactory:[63,1,1,""]},"com.vmware.vcenter.consumption_domains.zones.cluster_client.Associations":{Status:[63,1,1,""],add:[63,2,1,""],get:[63,2,1,""],remove:[63,2,1,""]},"com.vmware.vcenter.consumption_domains_client":{StubFactory:[52,1,1,""],Zones:[52,1,1,""]},"com.vmware.vcenter.consumption_domains_client.Zones":{"delete":[52,2,1,""],CreateSpec:[52,1,1,""],FilterSpec:[52,1,1,""],Info:[52,1,1,""],ListItem:[52,1,1,""],ListResult:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],create:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""]},"com.vmware.vcenter.content":{registries:[65,0,0,"-"],registries_client:[64,0,0,"-"]},"com.vmware.vcenter.content.registries":{harbor_client:[65,0,0,"-"]},"com.vmware.vcenter.content.registries.harbor_client":{Projects:[65,1,1,""],StubFactory:[65,1,1,""]},"com.vmware.vcenter.content.registries.harbor_client.Projects":{"delete":[65,2,1,""],ConfigStatus:[65,1,1,""],CreateSpec:[65,1,1,""],Info:[65,1,1,""],Scope:[65,1,1,""],Summary:[65,1,1,""],create:[65,2,1,""],get:[65,2,1,""],list:[65,2,1,""],purge:[65,2,1,""]},"com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus":{ERROR:[65,3,1,""],PENDING:[65,3,1,""],READY:[65,3,1,""],REMOVING:[65,3,1,""]},"com.vmware.vcenter.content.registries.harbor_client.Projects.Scope":{PRIVATE:[65,3,1,""],PUBLIC:[65,3,1,""]},"com.vmware.vcenter.content.registries_client":{DayOfWeek:[64,1,1,""],Harbor:[64,1,1,""],Health:[64,1,1,""],Recurrence:[64,1,1,""],StubFactory:[64,1,1,""]},"com.vmware.vcenter.content.registries_client.DayOfWeek":{FRIDAY:[64,3,1,""],MONDAY:[64,3,1,""],SATURDAY:[64,3,1,""],SUNDAY:[64,3,1,""],THURSDAY:[64,3,1,""],TUESDAY:[64,3,1,""],WEDNESDAY:[64,3,1,""]},"com.vmware.vcenter.content.registries_client.Harbor":{"delete":[64,2,1,""],CreateSpec:[64,1,1,""],GarbageCollection:[64,1,1,""],Info:[64,1,1,""],StorageInfo:[64,1,1,""],StorageSpec:[64,1,1,""],Summary:[64,1,1,""],create:[64,2,1,""],get:[64,2,1,""],list:[64,2,1,""]},"com.vmware.vcenter.content.registries_client.Health":{Info:[64,1,1,""],Status:[64,1,1,""],get:[64,2,1,""]},"com.vmware.vcenter.content.registries_client.Health.Status":{DELETING:[64,3,1,""],ERROR:[64,3,1,""],RUNNING:[64,3,1,""],STARTING:[64,3,1,""],WARNING:[64,3,1,""]},"com.vmware.vcenter.content.registries_client.Recurrence":{DAILY:[64,3,1,""],NONE:[64,3,1,""],WEEKLY:[64,3,1,""]},"com.vmware.vcenter.crypto_manager":{hosts:[67,0,0,"-"],hosts_client:[66,0,0,"-"],kms_client:[66,0,0,"-"]},"com.vmware.vcenter.crypto_manager.hosts":{kms_client:[67,0,0,"-"]},"com.vmware.vcenter.crypto_manager.hosts.kms_client":{Providers:[67,1,1,""],StubFactory:[67,1,1,""]},"com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers":{FilterSpec:[67,1,1,""],Health:[67,1,1,""],Info:[67,1,1,""],NativeProviderInfo:[67,1,1,""],Summary:[67,1,1,""],Type:[67,1,1,""],get:[67,2,1,""],list:[67,2,1,""]},"com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Health":{ERROR:[67,3,1,""],NONE:[67,3,1,""],OK:[67,3,1,""],WARNING:[67,3,1,""]},"com.vmware.vcenter.crypto_manager.hosts.kms_client.Providers.Type":{NATIVE:[67,3,1,""],TRUST_AUTHORITY:[67,3,1,""]},"com.vmware.vcenter.crypto_manager.hosts_client":{StubFactory:[66,1,1,""]},"com.vmware.vcenter.crypto_manager.kms_client":{Providers:[66,1,1,""],StubFactory:[66,1,1,""]},"com.vmware.vcenter.crypto_manager.kms_client.Providers":{"delete":[66,2,1,""],"export":[66,2,1,""],Constraints:[66,1,1,""],ConstraintsSpec:[66,1,1,""],CreateSpec:[66,1,1,""],ExportResult:[66,1,1,""],ExportSpec:[66,1,1,""],ExportType:[66,1,1,""],FilterSpec:[66,1,1,""],Health:[66,1,1,""],ImportResult:[66,1,1,""],ImportSpec:[66,1,1,""],Info:[66,1,1,""],Location:[66,1,1,""],NativeProviderCreateSpec:[66,1,1,""],NativeProviderInfo:[66,1,1,""],NativeProviderUpdateSpec:[66,1,1,""],RESOURCE_TYPE:[66,3,1,""],Summary:[66,1,1,""],Token:[66,1,1,""],Type:[66,1,1,""],UpdateSpec:[66,1,1,""],create:[66,2,1,""],get:[66,2,1,""],import_provider:[66,2,1,""],list:[66,2,1,""],update:[66,2,1,""]},"com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType":{LOCATION:[66,3,1,""]},"com.vmware.vcenter.crypto_manager.kms_client.Providers.Health":{ERROR:[66,3,1,""],NONE:[66,3,1,""],OK:[66,3,1,""],WARNING:[66,3,1,""]},"com.vmware.vcenter.crypto_manager.kms_client.Providers.Type":{NATIVE:[66,3,1,""]},"com.vmware.vcenter.crypto_manager_client":{StubFactory:[52,1,1,""]},"com.vmware.vcenter.datastore_client":{DefaultPolicy:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.datastore_client.DefaultPolicy":{get:[52,2,1,""]},"com.vmware.vcenter.deployment":{install:[69,0,0,"-"],install_client:[68,0,0,"-"],migrate_client:[68,0,0,"-"]},"com.vmware.vcenter.deployment.install":{initial_config:[70,0,0,"-"],psc_client:[69,0,0,"-"]},"com.vmware.vcenter.deployment.install.initial_config":{remote_psc_client:[70,0,0,"-"]},"com.vmware.vcenter.deployment.install.initial_config.remote_psc_client":{StubFactory:[70,1,1,""],Thumbprint:[70,1,1,""]},"com.vmware.vcenter.deployment.install.initial_config.remote_psc_client.Thumbprint":{RemoteSpec:[70,1,1,""],get:[70,2,1,""]},"com.vmware.vcenter.deployment.install.psc_client":{Replicated:[69,1,1,""],Standalone:[69,1,1,""],StubFactory:[69,1,1,""]},"com.vmware.vcenter.deployment.install.psc_client.Replicated":{check:[69,2,1,""]},"com.vmware.vcenter.deployment.install.psc_client.Standalone":{check:[69,2,1,""]},"com.vmware.vcenter.deployment.install_client":{RemotePsc:[68,1,1,""],StubFactory:[68,1,1,""]},"com.vmware.vcenter.deployment.install_client.RemotePsc":{check:[68,2,1,""]},"com.vmware.vcenter.deployment.migrate_client":{ActiveDirectory:[68,1,1,""],ActiveDirectorySpec:[68,1,1,""],StubFactory:[68,1,1,""]},"com.vmware.vcenter.deployment.migrate_client.ActiveDirectory":{CheckSpec:[68,1,1,""],check:[68,2,1,""]},"com.vmware.vcenter.deployment_client":{ApplianceSize:[52,1,1,""],ApplianceState:[52,1,1,""],ApplianceType:[52,1,1,""],CheckInfo:[52,1,1,""],CheckStatus:[52,1,1,""],DataMigrationEstimate:[52,1,1,""],DataMigrationInfo:[52,1,1,""],HistoryMigrationOption:[52,1,1,""],HistoryMigrationSpec:[52,1,1,""],ImportHistory:[52,1,1,""],Install:[52,1,1,""],LocationSpec:[52,1,1,""],Migrate:[52,1,1,""],Notification:[52,1,1,""],Notifications:[52,1,1,""],Operation:[52,1,1,""],Question:[52,1,1,""],RemotePscSpec:[52,1,1,""],ReplicatedPscSpec:[52,1,1,""],ReplicatedSpec:[52,1,1,""],SourceInfo:[52,1,1,""],StandalonePscSpec:[52,1,1,""],StandaloneSpec:[52,1,1,""],StubFactory:[52,1,1,""],Upgrade:[52,1,1,""],VerificationMode:[52,1,1,""]},"com.vmware.vcenter.deployment_client.ApplianceSize":{LARGE:[52,3,1,""],MEDIUM:[52,3,1,""],SMALL:[52,3,1,""],TINY:[52,3,1,""],XLARGE:[52,3,1,""]},"com.vmware.vcenter.deployment_client.ApplianceState":{CONFIGURED:[52,3,1,""],CONFIG_IN_PROGRESS:[52,3,1,""],FAILED:[52,3,1,""],INITIALIZED:[52,3,1,""],NOT_INITIALIZED:[52,3,1,""],QUESTION_RAISED:[52,3,1,""]},"com.vmware.vcenter.deployment_client.ApplianceType":{PSC_EXTERNAL:[52,3,1,""],VCSA_EMBEDDED:[52,3,1,""],VCSA_EXTERNAL:[52,3,1,""]},"com.vmware.vcenter.deployment_client.CheckStatus":{FAILED:[52,3,1,""],SUCCESS:[52,3,1,""]},"com.vmware.vcenter.deployment_client.HistoryMigrationOption":{ALL:[52,3,1,""],EVENTS_TASKS:[52,3,1,""]},"com.vmware.vcenter.deployment_client.ImportHistory":{CreateSpec:[52,1,1,""],Info:[52,1,1,""],cancel:[52,2,1,""],get:[52,2,1,""],pause:[52,2,1,""],resume:[52,2,1,""],start:[52,2,1,""]},"com.vmware.vcenter.deployment_client.Install":{InstallSpec:[52,1,1,""],VcsaEmbeddedSpec:[52,1,1,""],cancel:[52,2,1,""],check:[52,2,1,""],get:[52,2,1,""],start:[52,2,1,""]},"com.vmware.vcenter.deployment_client.Migrate":{MigrateSpec:[52,1,1,""],MigrationAssistantSpec:[52,1,1,""],PscSpec:[52,1,1,""],SourceVcWindows:[52,1,1,""],VcsaEmbeddedSpec:[52,1,1,""],cancel:[52,2,1,""],check:[52,2,1,""],get:[52,2,1,""],start:[52,2,1,""]},"com.vmware.vcenter.deployment_client.Operation":{INSTALL:[52,3,1,""],MIGRATE:[52,3,1,""],RESTORE:[52,3,1,""],ROLLBACK:[52,3,1,""],UPGRADE:[52,3,1,""]},"com.vmware.vcenter.deployment_client.Question":{AnswerSpec:[52,1,1,""],Info:[52,1,1,""],Question:[52,1,1,""],QuestionType:[52,1,1,""],answer:[52,2,1,""],get:[52,2,1,""]},"com.vmware.vcenter.deployment_client.Question.QuestionType":{ABORT_RETRY_IGNORE:[52,3,1,""],OK_CANCEL:[52,3,1,""],YES_NO:[52,3,1,""]},"com.vmware.vcenter.deployment_client.Upgrade":{PscSpec:[52,1,1,""],SourceApplianceSpec:[52,1,1,""],UpgradeSpec:[52,1,1,""],VcsaEmbeddedSpec:[52,1,1,""],cancel:[52,2,1,""],check:[52,2,1,""],get:[52,2,1,""],start:[52,2,1,""]},"com.vmware.vcenter.deployment_client.VerificationMode":{NONE:[52,3,1,""],THUMBPRINT:[52,3,1,""]},"com.vmware.vcenter.guest_client":{AdapterMapping:[52,1,1,""],CloudConfiguration:[52,1,1,""],CloudinitConfiguration:[52,1,1,""],ConfigurationSpec:[52,1,1,""],CustomizationSpec:[52,1,1,""],CustomizationSpecs:[52,1,1,""],Domain:[52,1,1,""],GlobalDNSSettings:[52,1,1,""],GuiUnattended:[52,1,1,""],HostnameGenerator:[52,1,1,""],IPSettings:[52,1,1,""],Ipv4:[52,1,1,""],Ipv6:[52,1,1,""],Ipv6Address:[52,1,1,""],LinuxConfiguration:[52,1,1,""],StubFactory:[52,1,1,""],UserData:[52,1,1,""],WindowsConfiguration:[52,1,1,""],WindowsNetworkAdapterSettings:[52,1,1,""],WindowsSysprep:[52,1,1,""]},"com.vmware.vcenter.guest_client.CloudConfiguration":{Type:[52,1,1,""]},"com.vmware.vcenter.guest_client.CloudConfiguration.Type":{CLOUDINIT:[52,3,1,""]},"com.vmware.vcenter.guest_client.CustomizationSpecs":{"delete":[52,2,1,""],"export":[52,2,1,""],CreateSpec:[52,1,1,""],FilterSpec:[52,1,1,""],Format:[52,1,1,""],Info:[52,1,1,""],Metadata:[52,1,1,""],OsType:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],Spec:[52,1,1,""],Summary:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],import_specification:[52,2,1,""],list:[52,2,1,""],set:[52,2,1,""]},"com.vmware.vcenter.guest_client.CustomizationSpecs.Format":{JSON:[52,3,1,""],XML:[52,3,1,""]},"com.vmware.vcenter.guest_client.CustomizationSpecs.OsType":{LINUX:[52,3,1,""],WINDOWS:[52,3,1,""]},"com.vmware.vcenter.guest_client.Domain":{Type:[52,1,1,""]},"com.vmware.vcenter.guest_client.Domain.Type":{DOMAIN:[52,3,1,""],WORKGROUP:[52,3,1,""]},"com.vmware.vcenter.guest_client.HostnameGenerator":{Type:[52,1,1,""]},"com.vmware.vcenter.guest_client.HostnameGenerator.Type":{FIXED:[52,3,1,""],PREFIX:[52,3,1,""],USER_INPUT_REQUIRED:[52,3,1,""],VIRTUAL_MACHINE:[52,3,1,""]},"com.vmware.vcenter.guest_client.Ipv4":{Type:[52,1,1,""]},"com.vmware.vcenter.guest_client.Ipv4.Type":{DHCP:[52,3,1,""],STATIC:[52,3,1,""],USER_INPUT_REQUIRED:[52,3,1,""]},"com.vmware.vcenter.guest_client.Ipv6":{Type:[52,1,1,""]},"com.vmware.vcenter.guest_client.Ipv6.Type":{DHCP:[52,3,1,""],STATIC:[52,3,1,""],USER_INPUT_REQUIRED:[52,3,1,""]},"com.vmware.vcenter.guest_client.WindowsConfiguration":{RebootOption:[52,1,1,""]},"com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption":{NO_REBOOT:[52,3,1,""],REBOOT:[52,3,1,""],SHUTDOWN:[52,3,1,""]},"com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings":{NetBIOSMode:[52,1,1,""]},"com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode":{DISABLE:[52,3,1,""],ENABLE:[52,3,1,""],USE_DHCP:[52,3,1,""]},"com.vmware.vcenter.host":{entropy_client:[71,0,0,"-"]},"com.vmware.vcenter.host.entropy_client":{ExternalPool:[71,1,1,""],StubFactory:[71,1,1,""]},"com.vmware.vcenter.host.entropy_client.ExternalPool":{AddResult:[71,1,1,""],AddSpec:[71,1,1,""],Info:[71,1,1,""],Status:[71,1,1,""],add:[71,2,1,""],get:[71,2,1,""]},"com.vmware.vcenter.host.entropy_client.ExternalPool.Status":{DISABLED:[71,3,1,""],ENABLED:[71,3,1,""]},"com.vmware.vcenter.host_client":{StubFactory:[52,1,1,""]},"com.vmware.vcenter.hvc":{management_client:[72,0,0,"-"]},"com.vmware.vcenter.hvc.management_client":{Administrators:[72,1,1,""],StubFactory:[72,1,1,""]},"com.vmware.vcenter.hvc.management_client.Administrators":{add:[72,2,1,""],get:[72,2,1,""],remove:[72,2,1,""],set:[72,2,1,""]},"com.vmware.vcenter.hvc_client":{Links:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.hvc_client.Links":{"delete":[52,2,1,""],CertificateInfo:[52,1,1,""],CreateSpec:[52,1,1,""],Credentials:[52,1,1,""],Info:[52,1,1,""],Summary:[52,1,1,""],create:[52,2,1,""],delete_with_credentials:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""]},"com.vmware.vcenter.hvc_client.Links.Info":{HealthStatus:[52,1,1,""]},"com.vmware.vcenter.hvc_client.Links.Info.HealthStatus":{HEALTHY:[52,3,1,""],UNHEALTHY:[52,3,1,""]},"com.vmware.vcenter.identity":{broker:[74,0,0,"-"],broker_client:[73,0,0,"-"]},"com.vmware.vcenter.identity.broker":{tenants_client:[74,0,0,"-"]},"com.vmware.vcenter.identity.broker.tenants_client":{AdminClient:[74,1,1,""],OperatorClient:[74,1,1,""],StubFactory:[74,1,1,""],TokenInfo:[74,1,1,""]},"com.vmware.vcenter.identity.broker.tenants_client.AdminClient":{get:[74,2,1,""]},"com.vmware.vcenter.identity.broker.tenants_client.OperatorClient":{get:[74,2,1,""]},"com.vmware.vcenter.identity.broker.tenants_client.TokenInfo":{BEARER_TOKEN_METHOD_TYPE:[74,3,1,""]},"com.vmware.vcenter.identity.broker_client":{StubFactory:[73,1,1,""]},"com.vmware.vcenter.identity_client":{FederationType:[52,1,1,""],Providers:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.identity_client.FederationType":{DIRECT_FEDERATION:[52,3,1,""],INDIRECT_FEDERATION:[52,3,1,""]},"com.vmware.vcenter.identity_client.Providers":{"delete":[52,2,1,""],ActiveDirectoryOverLdap:[52,1,1,""],ConfigType:[52,1,1,""],CreateSpec:[52,1,1,""],IdmProtocol:[52,1,1,""],Info:[52,1,1,""],Oauth2AuthenticationMethod:[52,1,1,""],Oauth2CreateSpec:[52,1,1,""],Oauth2Info:[52,1,1,""],Oauth2Summary:[52,1,1,""],Oauth2UpdateSpec:[52,1,1,""],OidcCreateSpec:[52,1,1,""],OidcInfo:[52,1,1,""],OidcSummary:[52,1,1,""],OidcUpdateSpec:[52,1,1,""],Summary:[52,1,1,""],UpdateSpec:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.identity_client.Providers.ConfigType":{Oauth2:[52,3,1,""],Oidc:[52,3,1,""]},"com.vmware.vcenter.identity_client.Providers.IdmProtocol":{LDAP:[52,3,1,""],REST:[52,3,1,""],SCIM2_0:[52,3,1,""],SCIM:[52,3,1,""]},"com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod":{CLIENT_SECRET_BASIC:[52,3,1,""],CLIENT_SECRET_JWT:[52,3,1,""],CLIENT_SECRET_POST:[52,3,1,""],PRIVATE_KEY_JWT:[52,3,1,""]},"com.vmware.vcenter.inventory_client":{Datastore:[52,1,1,""],Network:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.inventory_client.Datastore":{Info:[52,1,1,""],find:[52,2,1,""]},"com.vmware.vcenter.inventory_client.Network":{Info:[52,1,1,""],find:[52,2,1,""]},"com.vmware.vcenter.iso_client":{Image:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.iso_client.Image":{mount:[52,2,1,""],unmount:[52,2,1,""]},"com.vmware.vcenter.lcm":{deployment:[76,0,0,"-"],deployment_client:[75,0,0,"-"],discovery_client:[75,0,0,"-"],update_client:[75,0,0,"-"]},"com.vmware.vcenter.lcm.deployment":{common_client:[76,0,0,"-"]},"com.vmware.vcenter.lcm.deployment.common_client":{AllocateResource:[76,1,1,""],ResourceAllocationInfo:[76,1,1,""],StubFactory:[76,1,1,""]},"com.vmware.vcenter.lcm.deployment.common_client.AllocateResource":{ON_DEPLOYMENT:[76,3,1,""],ON_SUCCESSFUL_UPGRADE:[76,3,1,""]},"com.vmware.vcenter.lcm.deployment_client":{StubFactory:[75,1,1,""]},"com.vmware.vcenter.lcm.discovery_client":{AssociatedProducts:[75,1,1,""],InteropReport:[75,1,1,""],Product:[75,1,1,""],ProductCatalog:[75,1,1,""],StubFactory:[75,1,1,""]},"com.vmware.vcenter.lcm.discovery_client.AssociatedProducts":{"delete":[75,2,1,""],CreateSpec:[75,1,1,""],RESOURCE_TYPE:[75,3,1,""],UpdateSpec:[75,1,1,""],create:[75,2,1,""],get:[75,2,1,""],list:[75,2,1,""],update:[75,2,1,""]},"com.vmware.vcenter.lcm.discovery_client.InteropReport":{ReleaseInfo:[75,1,1,""],Report:[75,1,1,""],ReportRow:[75,1,1,""],ReportSummary:[75,1,1,""],Result:[75,1,1,""],Spec:[75,1,1,""],create_task:[75,2,1,""]},"com.vmware.vcenter.lcm.discovery_client.ProductCatalog":{Summary:[75,1,1,""],list:[75,2,1,""]},"com.vmware.vcenter.lcm.update_client":{Pending:[75,1,1,""],PrecheckReport:[75,1,1,""],StubFactory:[75,1,1,""]},"com.vmware.vcenter.lcm.update_client.Pending":{Category:[75,1,1,""],Info:[75,1,1,""],ListResult:[75,1,1,""],RESOURCE_TYPE:[75,3,1,""],SeverityType:[75,1,1,""],Summary:[75,1,1,""],UpdateType:[75,1,1,""],get:[75,2,1,""],list:[75,2,1,""]},"com.vmware.vcenter.lcm.update_client.Pending.Category":{FIX:[75,3,1,""],SECURITY:[75,3,1,""],UPDATE:[75,3,1,""],UPGRADE:[75,3,1,""]},"com.vmware.vcenter.lcm.update_client.Pending.SeverityType":{CRITICAL:[75,3,1,""],IMPORTANT:[75,3,1,""],LOW:[75,3,1,""],MODERATE:[75,3,1,""]},"com.vmware.vcenter.lcm.update_client.Pending.UpdateType":{PATCH:[75,3,1,""],UPDATE:[75,3,1,""],UPGRADE:[75,3,1,""]},"com.vmware.vcenter.lcm.update_client.PrecheckReport":{RESOURCE_TYPE:[75,3,1,""],Report:[75,1,1,""],ReportSummary:[75,1,1,""],Result:[75,1,1,""],create_task:[75,2,1,""]},"com.vmware.vcenter.lcm_client":{Notification:[52,1,1,""],Notifications:[52,1,1,""],Reports:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.lcm_client.Reports":{Location:[52,1,1,""],Token:[52,1,1,""],get:[52,2,1,""]},"com.vmware.vcenter.namespace_management":{clusters_client:[77,0,0,"-"],cns_client:[77,0,0,"-"],networks:[78,0,0,"-"],networks_client:[77,0,0,"-"],software_client:[77,0,0,"-"],stats_client:[77,0,0,"-"],storage_client:[77,0,0,"-"],supervisor_services_client:[77,0,0,"-"],supervisors:[80,0,0,"-"],supervisors_client:[77,0,0,"-"]},"com.vmware.vcenter.namespace_management.clusters_client":{StubFactory:[77,1,1,""],Topology:[77,1,1,""]},"com.vmware.vcenter.namespace_management.clusters_client.Topology":{get:[77,2,1,""]},"com.vmware.vcenter.namespace_management.cns_client":{MaintenanceActionType:[77,1,1,""],StubFactory:[77,1,1,""]},"com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType":{EnsureAccessibility:[77,3,1,""],NoAction:[77,3,1,""],PermanentRemoval:[77,3,1,""]},"com.vmware.vcenter.namespace_management.networks":{edges_client:[78,0,0,"-"],nsx:[79,0,0,"-"],nsx_client:[78,0,0,"-"],service_client:[78,0,0,"-"]},"com.vmware.vcenter.namespace_management.networks.edges_client":{Edge:[78,1,1,""],EdgeProvider:[78,1,1,""],HAProxyConfig:[78,1,1,""],LoadBalancerSize:[78,1,1,""],NSXAdvancedLBConfig:[78,1,1,""],NSXConfig:[78,1,1,""],NSXRoutingMode:[78,1,1,""],Server:[78,1,1,""],StubFactory:[78,1,1,""]},"com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider":{HAPROXY:[78,3,1,""],NSX:[78,3,1,""],NSX_ADVANCED:[78,3,1,""]},"com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize":{LARGE:[78,3,1,""],MEDIUM:[78,3,1,""],SMALL:[78,3,1,""]},"com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode":{NAT:[78,3,1,""],ROUTED:[78,3,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx":{distributed_switches_client:[79,0,0,"-"],edges_client:[79,0,0,"-"]},"com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client":{Compatibility:[79,1,1,""],StubFactory:[79,1,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility":{Summary:[79,1,1,""],check:[79,2,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx.edges_client":{Compatibility:[79,1,1,""],StubFactory:[79,1,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility":{Summary:[79,1,1,""],check:[79,2,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx_client":{DistributedSwitches:[78,1,1,""],Edges:[78,1,1,""],StubFactory:[78,1,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches":{FilterSpec:[78,1,1,""],Summary:[78,1,1,""],list:[78,2,1,""]},"com.vmware.vcenter.namespace_management.networks.nsx_client.Edges":{FilterSpec:[78,1,1,""],Summary:[78,1,1,""],list:[78,2,1,""]},"com.vmware.vcenter.namespace_management.networks.service_client":{DNS:[78,1,1,""],NTP:[78,1,1,""],StubFactory:[78,1,1,""]},"com.vmware.vcenter.namespace_management.networks_client":{IPAssignment:[77,1,1,""],IPManagement:[77,1,1,""],IPRange:[77,1,1,""],Services:[77,1,1,""],StubFactory:[77,1,1,""]},"com.vmware.vcenter.namespace_management.networks_client.IPAssignment":{Assignment:[77,1,1,""]},"com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment":{NODE:[77,3,1,""],POD:[77,3,1,""],SERVICE:[77,3,1,""]},"com.vmware.vcenter.namespace_management.software_client":{Clusters:[77,1,1,""],StubFactory:[77,1,1,""]},"com.vmware.vcenter.namespace_management.software_client.Clusters":{Info:[77,1,1,""],Message:[77,1,1,""],Result:[77,1,1,""],State:[77,1,1,""],Summary:[77,1,1,""],UpgradeProgress:[77,1,1,""],UpgradeSpec:[77,1,1,""],UpgradeStatus:[77,1,1,""],get:[77,2,1,""],list:[77,2,1,""],upgrade:[77,2,1,""],upgrade_multiple:[77,2,1,""]},"com.vmware.vcenter.namespace_management.software_client.Clusters.Message":{Severity:[77,1,1,""]},"com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity":{ERROR:[77,3,1,""],INFO:[77,3,1,""],WARNING:[77,3,1,""]},"com.vmware.vcenter.namespace_management.software_client.Clusters.Result":{Res:[77,1,1,""]},"com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res":{REJECTED:[77,3,1,""],STARTED:[77,3,1,""]},"com.vmware.vcenter.namespace_management.software_client.Clusters.State":{ERROR:[77,3,1,""],PENDING:[77,3,1,""],READY:[77,3,1,""]},"com.vmware.vcenter.namespace_management.stats_client":{StubFactory:[77,1,1,""],TimeSeries:[77,1,1,""]},"com.vmware.vcenter.namespace_management.stats_client.TimeSeries":{PodIdentifier:[77,1,1,""],Spec:[77,1,1,""],TimeSeries:[77,1,1,""],get:[77,2,1,""]},"com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec":{ObjType:[77,1,1,""]},"com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType":{CLUSTER:[77,3,1,""],NAMESPACE:[77,3,1,""],POD:[77,3,1,""]},"com.vmware.vcenter.namespace_management.storage_client":{Profiles:[77,1,1,""],StubFactory:[77,1,1,""]},"com.vmware.vcenter.namespace_management.storage_client.Profiles":{FilterSpec:[77,1,1,""],Item:[77,1,1,""],Summary:[77,1,1,""],check:[77,2,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client":{ClusterSupervisorServices:[77,1,1,""],StubFactory:[77,1,1,""],Versions:[77,1,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices":{"delete":[77,2,1,""],ConfigStatus:[77,1,1,""],CreateSpec:[77,1,1,""],Info:[77,1,1,""],Message:[77,1,1,""],SetSpec:[77,1,1,""],Summary:[77,1,1,""],create:[77,2,1,""],get:[77,2,1,""],list:[77,2,1,""],set:[77,2,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus":{CONFIGURED:[77,3,1,""],CONFIGURING:[77,3,1,""],ERROR:[77,3,1,""],REMOVING:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message":{MessageSeverity:[77,1,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity":{ERROR:[77,3,1,""],INFO:[77,3,1,""],WARNING:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.Versions":{"delete":[77,2,1,""],CarvelCreateSpec:[77,1,1,""],ContentType:[77,1,1,""],CreateSpec:[77,1,1,""],CustomCreateSpec:[77,1,1,""],Info:[77,1,1,""],State:[77,1,1,""],Summary:[77,1,1,""],VsphereCreateSpec:[77,1,1,""],activate:[77,2,1,""],create:[77,2,1,""],deactivate:[77,2,1,""],get:[77,2,1,""],list:[77,2,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType":{CARVEL_APPS_YAML:[77,3,1,""],CUSTOM_YAML:[77,3,1,""],VSPHERE_APPS_YAML:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State":{ACTIVATED:[77,3,1,""],DEACTIVATED:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors":{identity_client:[80,0,0,"-"],networks:[81,0,0,"-"]},"com.vmware.vcenter.namespace_management.supervisors.identity_client":{Providers:[80,1,1,""],StubFactory:[80,1,1,""]},"com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers":{"delete":[80,2,1,""],CreateSpec:[80,1,1,""],Info:[80,1,1,""],SetSpec:[80,1,1,""],Summary:[80,1,1,""],UpdateSpec:[80,1,1,""],create:[80,2,1,""],get:[80,2,1,""],list:[80,2,1,""],set:[80,2,1,""],update:[80,2,1,""]},"com.vmware.vcenter.namespace_management.supervisors.networks":{management_client:[81,0,0,"-"],workload_client:[81,0,0,"-"]},"com.vmware.vcenter.namespace_management.supervisors.networks.management_client":{Network:[81,1,1,""],NetworkBacking:[81,1,1,""],NetworkBackingEnum:[81,1,1,""],ProxyConfiguration:[81,1,1,""],ProxySettingsSource:[81,1,1,""],StubFactory:[81,1,1,""]},"com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum":{NETWORK:[81,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource":{CLUSTER_CONFIGURED:[81,3,1,""],NONE:[81,3,1,""],VC_INHERITED:[81,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors.networks.workload_client":{Network:[81,1,1,""],NetworkType:[81,1,1,""],NsxNetwork:[81,1,1,""],StubFactory:[81,1,1,""],VSphereNetwork:[81,1,1,""]},"com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType":{NSXT:[81,3,1,""],VSPHERE:[81,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client":{CNSFileConfig:[77,1,1,""],Conditions:[77,1,1,""],ContentLibrarySpec:[77,1,1,""],ControlPlane:[77,1,1,""],ImageRegistry:[77,1,1,""],ImageSyncConfig:[77,1,1,""],KubeAPIServerOptions:[77,1,1,""],KubeAPIServerSecurity:[77,1,1,""],SizingHint:[77,1,1,""],StubFactory:[77,1,1,""],Summary:[77,1,1,""],Topology:[77,1,1,""],Workloads:[77,1,1,""],WorkloadsStorageConfig:[77,1,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Conditions":{Condition:[77,1,1,""],Message:[77,1,1,""],Severity:[77,1,1,""],get:[77,2,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition":{Status:[77,1,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status":{FALSE:[77,3,1,""],TRUE:[77,3,1,""],UNKNOWN:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity":{ERROR:[77,3,1,""],INFO:[77,3,1,""],WARNING:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.SizingHint":{LARGE:[77,3,1,""],MEDIUM:[77,3,1,""],SMALL:[77,3,1,""],TINY:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Summary":{ConfigStatus:[77,1,1,""],FilterSpec:[77,1,1,""],Info:[77,1,1,""],KubernetesStatus:[77,1,1,""],ListItem:[77,1,1,""],ListResult:[77,1,1,""],Stats:[77,1,1,""],get:[77,2,1,""],list:[77,2,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus":{CONFIGURING:[77,3,1,""],ERROR:[77,3,1,""],REMOVING:[77,3,1,""],RUNNING:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus":{ERROR:[77,3,1,""],READY:[77,3,1,""],WARNING:[77,3,1,""]},"com.vmware.vcenter.namespace_management.supervisors_client.Topology":{Info:[77,1,1,""],get:[77,2,1,""]},"com.vmware.vcenter.namespace_management_client":{CNSFileConfig:[52,1,1,""],ClusterAvailableVersions:[52,1,1,""],ClusterCompatibility:[52,1,1,""],ClusterSizeInfo:[52,1,1,""],Clusters:[52,1,1,""],DistributedSwitchCompatibility:[52,1,1,""],EdgeClusterCompatibility:[52,1,1,""],HostsConfig:[52,1,1,""],IPRange:[52,1,1,""],Ipv4Cidr:[52,1,1,""],LoadBalancers:[52,1,1,""],NSXTier0Gateway:[52,1,1,""],NamespaceResourceOptions:[52,1,1,""],Networks:[52,1,1,""],ProxyConfiguration:[52,1,1,""],ProxySettingsSource:[52,1,1,""],SizingHint:[52,1,1,""],StubFactory:[52,1,1,""],SupervisorServices:[52,1,1,""],Supervisors:[52,1,1,""],SupportBundle:[52,1,1,""],VirtualMachineClasses:[52,1,1,""],WorkloadsStorageConfig:[52,1,1,""]},"com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions":{Summary:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.ClusterCompatibility":{FilterSpec:[52,1,1,""],FilterSpecV2:[52,1,1,""],Summary:[52,1,1,""],ZoneCompatibilityInfo:[52,1,1,""],ZoneFilterSpec:[52,1,1,""],ZoneSummary:[52,1,1,""],list:[52,2,1,""],list_v2:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.ClusterSizeInfo":{Info:[52,1,1,""],VmInfo:[52,1,1,""],get:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters":{Condition:[52,1,1,""],ConfigStatus:[52,1,1,""],ContentLibrarySpec:[52,1,1,""],EnableSpec:[52,1,1,""],ImageRegistry:[52,1,1,""],ImageStorageSpec:[52,1,1,""],Info:[52,1,1,""],Ipv4Range:[52,1,1,""],KubernetesStatus:[52,1,1,""],Message:[52,1,1,""],NCPClusterNetworkEnableSpec:[52,1,1,""],NCPClusterNetworkInfo:[52,1,1,""],NCPClusterNetworkSetSpec:[52,1,1,""],NCPClusterNetworkUpdateSpec:[52,1,1,""],NetworkProvider:[52,1,1,""],NetworkSpec:[52,1,1,""],SetSpec:[52,1,1,""],Stats:[52,1,1,""],Summary:[52,1,1,""],UpdateSpec:[52,1,1,""],WorkloadNetworksEnableSpec:[52,1,1,""],WorkloadNetworksInfo:[52,1,1,""],disable:[52,2,1,""],enable:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""],rotate_password:[52,2,1,""],set:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.Condition":{Severity:[52,1,1,""],Status:[52,1,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.Condition.Severity":{ERROR:[52,3,1,""],INFO:[52,3,1,""],WARNING:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.Condition.Status":{FALSE:[52,3,1,""],TRUE:[52,3,1,""],UNKNOWN:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus":{CONFIGURING:[52,3,1,""],ERROR:[52,3,1,""],REMOVING:[52,3,1,""],RUNNING:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus":{ERROR:[52,3,1,""],READY:[52,3,1,""],WARNING:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.Message":{Severity:[52,1,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity":{ERROR:[52,3,1,""],INFO:[52,3,1,""],WARNING:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider":{NSXT_CONTAINER_PLUGIN:[52,3,1,""],VSPHERE_NETWORK:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec":{Ipv4Mode:[52,1,1,""]},"com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode":{DHCP:[52,3,1,""],STATICRANGE:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility":{FilterSpec:[52,1,1,""],Summary:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility":{FilterSpec:[52,1,1,""],Summary:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.HostsConfig":{Info:[52,1,1,""],get:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.LoadBalancers":{AviConfigCreateSpec:[52,1,1,""],AviConfigSetSpec:[52,1,1,""],AviConfigUpdateSpec:[52,1,1,""],AviInfo:[52,1,1,""],ConfigSpec:[52,1,1,""],HAProxyConfigCreateSpec:[52,1,1,""],HAProxyConfigSetSpec:[52,1,1,""],HAProxyConfigUpdateSpec:[52,1,1,""],HAProxyInfo:[52,1,1,""],Info:[52,1,1,""],Provider:[52,1,1,""],Server:[52,1,1,""],SetSpec:[52,1,1,""],Summary:[52,1,1,""],UpdateSpec:[52,1,1,""],get:[52,2,1,""],list:[52,2,1,""],set:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider":{AVI:[52,3,1,""],HA_PROXY:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.NSXTier0Gateway":{Summary:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions":{Info:[52,1,1,""],get:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.Networks":{"delete":[52,2,1,""],CreateSpec:[52,1,1,""],IPAssignmentMode:[52,1,1,""],Info:[52,1,1,""],LoadBalancerSize:[52,1,1,""],NsxNetworkCreateSpec:[52,1,1,""],NsxNetworkInfo:[52,1,1,""],NsxNetworkSetSpec:[52,1,1,""],NsxNetworkUpdateSpec:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],SetSpec:[52,1,1,""],UpdateSpec:[52,1,1,""],VsphereDVPGNetworkCreateSpec:[52,1,1,""],VsphereDVPGNetworkInfo:[52,1,1,""],VsphereDVPGNetworkSetSpec:[52,1,1,""],VsphereDVPGNetworkUpdateSpec:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""],set:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode":{DHCP:[52,3,1,""],STATICRANGE:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize":{LARGE:[52,3,1,""],MEDIUM:[52,3,1,""],SMALL:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.ProxySettingsSource":{CLUSTER_CONFIGURED:[52,3,1,""],NONE:[52,3,1,""],VC_INHERITED:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.SizingHint":{LARGE:[52,3,1,""],MEDIUM:[52,3,1,""],SMALL:[52,3,1,""],TINY:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.SupervisorServices":{"delete":[52,2,1,""],CarvelAppsCheckResult:[52,1,1,""],CarvelCreateSpec:[52,1,1,""],CheckResult:[52,1,1,""],ContentCheckSpec:[52,1,1,""],CreateSpec:[52,1,1,""],CustomCreateSpec:[52,1,1,""],Info:[52,1,1,""],State:[52,1,1,""],Summary:[52,1,1,""],UpdateSpec:[52,1,1,""],ValidationStatus:[52,1,1,""],VsphereAppsCheckResult:[52,1,1,""],VsphereCreateSpec:[52,1,1,""],activate:[52,2,1,""],check_content:[52,2,1,""],create:[52,2,1,""],deactivate:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.SupervisorServices.State":{ACTIVATED:[52,3,1,""],DEACTIVATED:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus":{INVALID:[52,3,1,""],VALID:[52,3,1,""],VALID_WITH_WARNINGS:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.Supervisors":{EnableOnComputeClusterSpec:[52,1,1,""],EnableOnZonesSpec:[52,1,1,""],EnableSpec:[52,1,1,""],enable_on_compute_cluster:[52,2,1,""],enable_on_zones:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.SupportBundle":{Location:[52,1,1,""],Token:[52,1,1,""],create:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.VirtualMachineClasses":{"delete":[52,2,1,""],ConfigStatus:[52,1,1,""],CreateSpec:[52,1,1,""],DynamicDirectPathIODevice:[52,1,1,""],Info:[52,1,1,""],InstanceStorage:[52,1,1,""],InstanceStorageVolume:[52,1,1,""],Message:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],UpdateSpec:[52,1,1,""],VGPUDevice:[52,1,1,""],VirtualDevices:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus":{READY:[52,3,1,""],REMOVING:[52,3,1,""]},"com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message":{MessageSeverity:[52,1,1,""]},"com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity":{ERROR:[52,3,1,""],INFO:[52,3,1,""],WARNING:[52,3,1,""]},"com.vmware.vcenter.namespaces":{user_client:[82,0,0,"-"]},"com.vmware.vcenter.namespaces.user_client":{Instances:[82,1,1,""],StubFactory:[82,1,1,""]},"com.vmware.vcenter.namespaces.user_client.Instances":{FilterSpec:[82,1,1,""],Summary:[82,1,1,""],list:[82,2,1,""]},"com.vmware.vcenter.namespaces_client":{Access:[52,1,1,""],Instances:[52,1,1,""],NamespaceSelfService:[52,1,1,""],NamespaceTemplates:[52,1,1,""],ResourceQuotaOptionsV1:[52,1,1,""],ResourceQuotaOptionsV1Update:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.namespaces_client.Access":{"delete":[52,2,1,""],CreateSpec:[52,1,1,""],Info:[52,1,1,""],Role:[52,1,1,""],SetSpec:[52,1,1,""],SubjectType:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],set:[52,2,1,""]},"com.vmware.vcenter.namespaces_client.Access.Role":{EDIT:[52,3,1,""],OWNER:[52,3,1,""],VIEW:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.Access.SubjectType":{GROUP:[52,3,1,""],USER:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.Instances":{"delete":[52,2,1,""],Access:[52,1,1,""],ConfigStatus:[52,1,1,""],ContentLibrarySpec:[52,1,1,""],CreateSpec:[52,1,1,""],CreateSpecV2:[52,1,1,""],Info:[52,1,1,""],InfoV2:[52,1,1,""],Ipv4Cidr:[52,1,1,""],LoadBalancerSize:[52,1,1,""],Message:[52,1,1,""],NetworkCreateSpec:[52,1,1,""],NetworkProvider:[52,1,1,""],NsxNetworkCreateSpec:[52,1,1,""],Principal:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],SetSpec:[52,1,1,""],Stats:[52,1,1,""],StorageSpec:[52,1,1,""],Summary:[52,1,1,""],SummaryV2:[52,1,1,""],UpdateSpec:[52,1,1,""],VMServiceSpec:[52,1,1,""],create:[52,2,1,""],create_v2:[52,2,1,""],get:[52,2,1,""],get_v2:[52,2,1,""],list:[52,2,1,""],list_v2:[52,2,1,""],set:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.namespaces_client.Instances.ConfigStatus":{CONFIGURING:[52,3,1,""],ERROR:[52,3,1,""],REMOVING:[52,3,1,""],RUNNING:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize":{LARGE:[52,3,1,""],MEDIUM:[52,3,1,""],SMALL:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.Instances.Message":{MessageSeverity:[52,1,1,""]},"com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity":{ERROR:[52,3,1,""],INFO:[52,3,1,""],WARNING:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.Instances.NetworkProvider":{NSXT_CONTAINER_PLUGIN:[52,3,1,""],VSPHERE_NETWORK:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.NamespaceSelfService":{ActivateTemplateSpec:[52,1,1,""],Capability:[52,1,1,""],Info:[52,1,1,""],Status:[52,1,1,""],Summary:[52,1,1,""],activate:[52,2,1,""],activate_with_template:[52,2,1,""],deactivate:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""]},"com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability":{NOTSUPPORTED:[52,3,1,""],SUPPORTED:[52,3,1,""],UNKNOWN:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status":{CONFIGURING:[52,3,1,""],DEACTIVATED:[52,3,1,""],ERROR:[52,3,1,""],REMOVING:[52,3,1,""],RUNNING:[52,3,1,""]},"com.vmware.vcenter.namespaces_client.NamespaceTemplates":{CreateSpec:[52,1,1,""],Info:[52,1,1,""],InfoV2:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],Subject:[52,1,1,""],Summary:[52,1,1,""],SummaryV2:[52,1,1,""],UpdateSpec:[52,1,1,""],create:[52,2,1,""],create_v2:[52,2,1,""],get:[52,2,1,""],get_v2:[52,2,1,""],list:[52,2,1,""],list_v2:[52,2,1,""],update:[52,2,1,""],update_v2:[52,2,1,""]},"com.vmware.vcenter.ovf_client":{CertificateParams:[52,1,1,""],DeploymentOption:[52,1,1,""],DeploymentOptionParams:[52,1,1,""],DiskProvisioningType:[52,1,1,""],ExportFlag:[52,1,1,""],ExtraConfig:[52,1,1,""],ExtraConfigParams:[52,1,1,""],ImportFlag:[52,1,1,""],IpAllocationParams:[52,1,1,""],LibraryItem:[52,1,1,""],OvfError:[52,1,1,""],OvfInfo:[52,1,1,""],OvfMessage:[52,1,1,""],OvfParams:[52,1,1,""],OvfWarning:[52,1,1,""],ParseIssue:[52,1,1,""],Property:[52,1,1,""],PropertyParams:[52,1,1,""],ScaleOutGroup:[52,1,1,""],ScaleOutParams:[52,1,1,""],SizeParams:[52,1,1,""],StubFactory:[52,1,1,""],UnknownSection:[52,1,1,""],UnknownSectionParams:[52,1,1,""],VcenterExtensionParams:[52,1,1,""],WarningInfo:[52,1,1,""],WarningType:[52,1,1,""]},"com.vmware.vcenter.ovf_client.DiskProvisioningType":{eagerZeroedThick:[52,3,1,""],thick:[52,3,1,""],thin:[52,3,1,""]},"com.vmware.vcenter.ovf_client.ExportFlag":{Info:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.ovf_client.ImportFlag":{Info:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.ovf_client.IpAllocationParams":{IpAllocationPolicy:[52,1,1,""],IpAllocationScheme:[52,1,1,""],IpProtocol:[52,1,1,""]},"com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy":{DHCP:[52,3,1,""],STATIC_IPPOOL:[52,3,1,""],STATIC_MANUAL:[52,3,1,""],TRANSIENT_IPPOOL:[52,3,1,""]},"com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme":{DHCP:[52,3,1,""],OVF_ENVIRONMENT:[52,3,1,""]},"com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol":{IPV4:[52,3,1,""],IPV6:[52,3,1,""]},"com.vmware.vcenter.ovf_client.LibraryItem":{CreateResult:[52,1,1,""],CreateSpec:[52,1,1,""],CreateTarget:[52,1,1,""],DEPLOYABLE:[52,3,1,""],DeployableIdentity:[52,1,1,""],DeploymentResult:[52,1,1,""],DeploymentTarget:[52,1,1,""],OvfSummary:[52,1,1,""],ResourcePoolDeploymentSpec:[52,1,1,""],ResultInfo:[52,1,1,""],StorageGroupMapping:[52,1,1,""],VmConfigSpec:[52,1,1,""],VmConfigSpecProvider:[52,1,1,""],create:[52,2,1,""],deploy:[52,2,1,""],filter:[52,2,1,""]},"com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping":{Type:[52,1,1,""]},"com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type":{DATASTORE:[52,3,1,""],STORAGE_PROFILE:[52,3,1,""]},"com.vmware.vcenter.ovf_client.LibraryItem.VmConfigSpecProvider":{XML:[52,3,1,""]},"com.vmware.vcenter.ovf_client.OvfMessage":{Category:[52,1,1,""]},"com.vmware.vcenter.ovf_client.OvfMessage.Category":{INPUT:[52,3,1,""],SERVER:[52,3,1,""],VALIDATION:[52,3,1,""]},"com.vmware.vcenter.ovf_client.ParseIssue":{Category:[52,1,1,""]},"com.vmware.vcenter.ovf_client.ParseIssue.Category":{ATTRIBUTE_ILLEGAL:[52,3,1,""],ATTRIBUTE_REQUIRED:[52,3,1,""],ELEMENT_ILLEGAL:[52,3,1,""],ELEMENT_REQUIRED:[52,3,1,""],ELEMENT_UNKNOWN:[52,3,1,""],EXPORT_ERROR:[52,3,1,""],GENERATE_ERROR:[52,3,1,""],INTERNAL_ERROR:[52,3,1,""],PARSE_ERROR:[52,3,1,""],SECTION_RESTRICTION:[52,3,1,""],SECTION_UNKNOWN:[52,3,1,""],VALIDATION_ERROR:[52,3,1,""],VALUE_ILLEGAL:[52,3,1,""]},"com.vmware.vcenter.ovf_client.WarningType":{EXPIRED_CERTIFICATE:[52,3,1,""],NOT_YET_VALID_CERTIFICATE:[52,3,1,""],SELF_SIGNED_CERTIFICATE:[52,3,1,""],UNTRUSTED_CERTIFICATE:[52,3,1,""]},"com.vmware.vcenter.services_client":{Service:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.services_client.Service":{Health:[52,1,1,""],Info:[52,1,1,""],StartupType:[52,1,1,""],State:[52,1,1,""],UpdateSpec:[52,1,1,""],get:[52,2,1,""],list_details:[52,2,1,""],restart:[52,2,1,""],start:[52,2,1,""],stop:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.services_client.Service.Health":{DEGRADED:[52,3,1,""],HEALTHY:[52,3,1,""],HEALTHY_WITH_WARNINGS:[52,3,1,""]},"com.vmware.vcenter.services_client.Service.StartupType":{AUTOMATIC:[52,3,1,""],DISABLED:[52,3,1,""],MANUAL:[52,3,1,""]},"com.vmware.vcenter.services_client.Service.State":{STARTED:[52,3,1,""],STARTING:[52,3,1,""],STOPPED:[52,3,1,""],STOPPING:[52,3,1,""]},"com.vmware.vcenter.storage":{policies:[84,0,0,"-"],policies_client:[83,0,0,"-"]},"com.vmware.vcenter.storage.policies":{compliance_client:[84,0,0,"-"]},"com.vmware.vcenter.storage.policies.compliance_client":{StubFactory:[84,1,1,""],VM:[84,1,1,""]},"com.vmware.vcenter.storage.policies.compliance_client.VM":{FilterSpec:[84,1,1,""],Info:[84,1,1,""],Status:[84,1,1,""],list:[84,2,1,""]},"com.vmware.vcenter.storage.policies.compliance_client.VM.Status":{COMPLIANT:[84,3,1,""],NON_COMPLIANT:[84,3,1,""],NOT_APPLICABLE:[84,3,1,""],OUT_OF_DATE:[84,3,1,""],UNKNOWN_COMPLIANCE:[84,3,1,""]},"com.vmware.vcenter.storage.policies_client":{Compliance:[83,1,1,""],StubFactory:[83,1,1,""],VM:[83,1,1,""]},"com.vmware.vcenter.storage.policies_client.Compliance":{FilterSpec:[83,1,1,""],Status:[83,1,1,""],Summary:[83,1,1,""],list:[83,2,1,""]},"com.vmware.vcenter.storage.policies_client.Compliance.Status":{COMPLIANT:[83,3,1,""],NON_COMPLIANT:[83,3,1,""],NOT_APPLICABLE:[83,3,1,""],OUT_OF_DATE:[83,3,1,""],UNKNOWN:[83,3,1,""]},"com.vmware.vcenter.storage.policies_client.VM":{Info:[83,1,1,""],list:[83,2,1,""]},"com.vmware.vcenter.storage_client":{Policies:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.storage_client.Policies":{CompatibilityInfo:[52,1,1,""],CompatibleDatastoreInfo:[52,1,1,""],FilterSpec:[52,1,1,""],RESOURCE_TYPE:[52,3,1,""],Summary:[52,1,1,""],check_compatibility:[52,2,1,""],list:[52,2,1,""]},"com.vmware.vcenter.system_config":{features:[86,0,0,"-"]},"com.vmware.vcenter.system_config.features":{tech_preview_client:[86,0,0,"-"]},"com.vmware.vcenter.system_config.features.tech_preview_client":{StubFactory:[86,1,1,""]},"com.vmware.vcenter.system_config_client":{DeploymentType:[52,1,1,""],PscRegistration:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.system_config_client.DeploymentType":{Info:[52,1,1,""],ReconfigureSpec:[52,1,1,""],get:[52,2,1,""],reconfigure:[52,2,1,""]},"com.vmware.vcenter.system_config_client.PscRegistration":{Info:[52,1,1,""],get:[52,2,1,""],repoint:[52,2,1,""]},"com.vmware.vcenter.tagging_client":{Associations:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.tagging_client.Associations":{IterationSpec:[52,1,1,""],LastIterationStatus:[52,1,1,""],ListResult:[52,1,1,""],Summary:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.tagging_client.Associations.LastIterationStatus":{END_OF_DATA:[52,3,1,""],READY:[52,3,1,""]},"com.vmware.vcenter.tokenservice_client":{Error:[52,4,1,""],InvalidGrant:[52,4,1,""],InvalidRequest:[52,4,1,""],InvalidScope:[52,4,1,""],StubFactory:[52,1,1,""],TokenExchange:[52,1,1,""]},"com.vmware.vcenter.tokenservice_client.TokenExchange":{ACCESS_TOKEN_TYPE:[52,3,1,""],BEARER_TOKEN_METHOD_TYPE:[52,3,1,""],ExchangeSpec:[52,1,1,""],ID_TOKEN_TYPE:[52,3,1,""],Info:[52,1,1,""],N_A_TOKEN_METHOD_TYPE:[52,3,1,""],REFRESH_TOKEN_TYPE:[52,3,1,""],SAML1_TOKEN_TYPE:[52,3,1,""],SAML2_TOKEN_TYPE:[52,3,1,""],TOKEN_EXCHANGE_GRANT:[52,3,1,""],exchange:[52,2,1,""]},"com.vmware.vcenter.topology_client":{Nodes:[52,1,1,""],ReplicationStatus:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.topology_client.Nodes":{ApplianceType:[52,1,1,""],FilterSpec:[52,1,1,""],Info:[52,1,1,""],Summary:[52,1,1,""],get:[52,2,1,""],list:[52,2,1,""]},"com.vmware.vcenter.topology_client.Nodes.ApplianceType":{PSC_EXTERNAL:[52,3,1,""],VCSA_EMBEDDED:[52,3,1,""],VCSA_EXTERNAL:[52,3,1,""]},"com.vmware.vcenter.topology_client.ReplicationStatus":{FilterSpec:[52,1,1,""],Summary:[52,1,1,""],list:[52,2,1,""]},"com.vmware.vcenter.trusted_infrastructure":{attestation_client:[87,0,0,"-"],hosts:[88,0,0,"-"],hosts_client:[87,0,0,"-"],kms_client:[87,0,0,"-"],trust_authority_clusters:[90,0,0,"-"],trust_authority_clusters_client:[87,0,0,"-"],trust_authority_hosts_client:[87,0,0,"-"],trusted_clusters:[95,0,0,"-"],trusted_clusters_client:[87,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.attestation_client":{Services:[87,1,1,""],StubFactory:[87,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.attestation_client.Services":{"delete":[87,2,1,""],CreateSpec:[87,1,1,""],FilterSpec:[87,1,1,""],Info:[87,1,1,""],RESOURCE_TYPE:[87,3,1,""],Summary:[87,1,1,""],create:[87,2,1,""],get:[87,2,1,""],list:[87,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts":{hardware:[89,0,0,"-"],hardware_client:[88,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware":{tpm_client:[89,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client":{EndorsementKeys:[89,1,1,""],EventLog:[89,1,1,""],HashAlgorithm:[89,1,1,""],PcrBank:[89,1,1,""],StubFactory:[89,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys":{FilterSpec:[89,1,1,""],Info:[89,1,1,""],PolicyPcrSpec:[89,1,1,""],RESOURCE_TYPE:[89,3,1,""],Summary:[89,1,1,""],Type:[89,1,1,""],UnsealSpec:[89,1,1,""],get:[89,2,1,""],list:[89,2,1,""],unseal:[89,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type":{ECC_NIST_P_256:[89,3,1,""],RSA_2048:[89,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog":{Info:[89,1,1,""],Type:[89,1,1,""],get:[89,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type":{EFI_TCG2_EVENT_LOG_FORMAT_TCG_2:[89,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm":{SHA256:[89,3,1,""],SHA384:[89,3,1,""],SHA512:[89,3,1,""],SM3_256:[89,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client":{StubFactory:[88,1,1,""],Tpm:[88,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm":{FilterSpec:[88,1,1,""],Info:[88,1,1,""],RESOURCE_TYPE:[88,3,1,""],Summary:[88,1,1,""],get:[88,2,1,""],list:[88,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.hosts_client":{StubFactory:[87,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.kms_client":{Services:[87,1,1,""],StubFactory:[87,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.kms_client.Services":{"delete":[87,2,1,""],CreateSpec:[87,1,1,""],FilterSpec:[87,1,1,""],Info:[87,1,1,""],RESOURCE_TYPE:[87,3,1,""],Summary:[87,1,1,""],create:[87,2,1,""],get:[87,2,1,""],list:[87,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters":{attestation:[91,0,0,"-"],attestation_client:[90,0,0,"-"],kms:[93,0,0,"-"],kms_client:[90,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation":{os:[92,0,0,"-"],tpm2_client:[91,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os":{esx_client:[92,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client":{BaseImages:[92,1,1,""],StubFactory:[92,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages":{FilterSpec:[92,1,1,""],Health:[92,1,1,""],Info:[92,1,1,""],RESOURCE_TYPE:[92,3,1,""],Summary:[92,1,1,""],delete_task:[92,2,1,""],get_task:[92,2,1,""],import_from_imgdb_task:[92,2,1,""],list_task:[92,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health":{ERROR:[92,3,1,""],NONE:[92,3,1,""],OK:[92,3,1,""],WARNING:[92,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client":{CaCertificates:[91,1,1,""],EndorsementKeys:[91,1,1,""],Settings:[91,1,1,""],StubFactory:[91,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.CaCertificates":{CreateSpec:[91,1,1,""],Health:[91,1,1,""],Info:[91,1,1,""],RESOURCE_TYPE:[91,3,1,""],Summary:[91,1,1,""],create_task:[91,2,1,""],delete_task:[91,2,1,""],get_task:[91,2,1,""],list_task:[91,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.CaCertificates.Health":{ERROR:[91,3,1,""],NONE:[91,3,1,""],OK:[91,3,1,""],WARNING:[91,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.EndorsementKeys":{CreateSpec:[91,1,1,""],Health:[91,1,1,""],Info:[91,1,1,""],RESOURCE_TYPE:[91,3,1,""],Summary:[91,1,1,""],create_task:[91,2,1,""],delete_task:[91,2,1,""],get_task:[91,2,1,""],list_task:[91,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.EndorsementKeys.Health":{ERROR:[91,3,1,""],NONE:[91,3,1,""],OK:[91,3,1,""],WARNING:[91,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.Settings":{Health:[91,1,1,""],Info:[91,1,1,""],UpdateSpec:[91,1,1,""],get_task:[91,2,1,""],update_task:[91,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client.Settings.Health":{ERROR:[91,3,1,""],NONE:[91,3,1,""],OK:[91,3,1,""],WARNING:[91,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client":{ServiceStatus:[90,1,1,""],StubFactory:[90,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus":{Health:[90,1,1,""],Info:[90,1,1,""],get_task:[90,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health":{ERROR:[90,3,1,""],NONE:[90,3,1,""],OK:[90,3,1,""],WARNING:[90,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms":{providers:[94,0,0,"-"],providers_client:[93,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers":{client_certificate_client:[94,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client":{Csr:[94,1,1,""],StubFactory:[94,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client.Csr":{Info:[94,1,1,""],create_task:[94,2,1,""],get_task:[94,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client":{ClientCertificate:[93,1,1,""],Credential:[93,1,1,""],CurrentPeerCertificates:[93,1,1,""],StubFactory:[93,1,1,""],TrustedPeerCertificates:[93,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.ClientCertificate":{Info:[93,1,1,""],UpdateSpec:[93,1,1,""],create_task:[93,2,1,""],get_task:[93,2,1,""],update_task:[93,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.Credential":{set_task:[93,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.CurrentPeerCertificates":{FilterSpec:[93,1,1,""],Summary:[93,1,1,""],list_task:[93,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client.TrustedPeerCertificates":{Info:[93,1,1,""],UpdateSpec:[93,1,1,""],get_task:[93,2,1,""],update_task:[93,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client":{Providers:[90,1,1,""],ServiceStatus:[90,1,1,""],StubFactory:[90,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers":{CreateSpec:[90,1,1,""],Health:[90,1,1,""],Info:[90,1,1,""],KeyServerCreateSpec:[90,1,1,""],KeyServerInfo:[90,1,1,""],KeyServerUpdateSpec:[90,1,1,""],KmipServerCreateSpec:[90,1,1,""],KmipServerInfo:[90,1,1,""],KmipServerUpdateSpec:[90,1,1,""],RESOURCE_TYPE:[90,3,1,""],Server:[90,1,1,""],ServerInfo:[90,1,1,""],Status:[90,1,1,""],Summary:[90,1,1,""],UpdateSpec:[90,1,1,""],create_task:[90,2,1,""],delete_task:[90,2,1,""],get_task:[90,2,1,""],list_task:[90,2,1,""],update_task:[90,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health":{ERROR:[90,3,1,""],NONE:[90,3,1,""],OK:[90,3,1,""],WARNING:[90,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec":{Type:[90,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type":{KMIP:[90,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo":{Type:[90,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type":{KMIP:[90,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec":{Type:[90,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type":{KMIP:[90,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus":{Health:[90,1,1,""],Info:[90,1,1,""],get_task:[90,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health":{ERROR:[90,3,1,""],NONE:[90,3,1,""],OK:[90,3,1,""],WARNING:[90,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client":{ConsumerPrincipals:[87,1,1,""],StubFactory:[87,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals":{CreateSpec:[87,1,1,""],FilterSpec:[87,1,1,""],Health:[87,1,1,""],Info:[87,1,1,""],Summary:[87,1,1,""],create_task:[87,2,1,""],delete_task:[87,2,1,""],get_task:[87,2,1,""],list_task:[87,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health":{ERROR:[87,3,1,""],NONE:[87,3,1,""],OK:[87,3,1,""],WARNING:[87,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client":{Attestation:[87,1,1,""],Kms:[87,1,1,""],StubFactory:[87,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation":{FilterSpec:[87,1,1,""],Info:[87,1,1,""],Summary:[87,1,1,""],SummaryType:[87,1,1,""],get:[87,2,1,""],list:[87,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType":{BRIEF:[87,3,1,""],FULL:[87,3,1,""],NORMAL:[87,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms":{FilterSpec:[87,1,1,""],Info:[87,1,1,""],Summary:[87,1,1,""],SummaryType:[87,1,1,""],get:[87,2,1,""],list:[87,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType":{BRIEF:[87,3,1,""],FULL:[87,3,1,""],NORMAL:[87,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters":{attestation_client:[95,0,0,"-"],kms_client:[95,0,0,"-"]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client":{Services:[95,1,1,""],ServicesAppliedConfig:[95,1,1,""],StubFactory:[95,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services":{CreateSpec:[95,1,1,""],FilterSpec:[95,1,1,""],Info:[95,1,1,""],Summary:[95,1,1,""],create_task:[95,2,1,""],delete_task:[95,2,1,""],get:[95,2,1,""],list:[95,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec":{SourceType:[95,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType":{CLUSTER:[95,3,1,""],SERVICE:[95,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.ServicesAppliedConfig":{FilterSpec:[95,1,1,""],Health:[95,1,1,""],Info:[95,1,1,""],Summary:[95,1,1,""],delete_task:[95,2,1,""],get_task:[95,2,1,""],list_task:[95,2,1,""],update_task:[95,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.ServicesAppliedConfig.Health":{ERROR:[95,3,1,""],NONE:[95,3,1,""],OK:[95,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client":{Services:[95,1,1,""],ServicesAppliedConfig:[95,1,1,""],StubFactory:[95,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services":{CreateSpec:[95,1,1,""],FilterSpec:[95,1,1,""],Info:[95,1,1,""],Summary:[95,1,1,""],create_task:[95,2,1,""],delete_task:[95,2,1,""],get:[95,2,1,""],list:[95,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec":{SourceType:[95,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType":{CLUSTER:[95,3,1,""],SERVICE:[95,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.ServicesAppliedConfig":{FilterSpec:[95,1,1,""],Health:[95,1,1,""],Info:[95,1,1,""],Summary:[95,1,1,""],delete_task:[95,2,1,""],get_task:[95,2,1,""],list_task:[95,2,1,""],update_task:[95,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.ServicesAppliedConfig.Health":{ERROR:[95,3,1,""],NONE:[95,3,1,""],OK:[95,3,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client":{ServicesAppliedConfig:[87,1,1,""],StubFactory:[87,1,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig":{Health:[87,1,1,""],Info:[87,1,1,""],delete_task:[87,2,1,""],get_task:[87,2,1,""],update_task:[87,2,1,""]},"com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health":{ERROR:[87,3,1,""],NONE:[87,3,1,""],OK:[87,3,1,""]},"com.vmware.vcenter.trusted_infrastructure_client":{NetworkAddress:[52,1,1,""],Principal:[52,1,1,""],StsPrincipal:[52,1,1,""],StsPrincipalId:[52,1,1,""],StsPrincipalType:[52,1,1,""],StubFactory:[52,1,1,""],TrustAuthorityClusters:[52,1,1,""],X509CertChain:[52,1,1,""]},"com.vmware.vcenter.trusted_infrastructure_client.Principal":{Info:[52,1,1,""],get:[52,2,1,""]},"com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType":{STS_GROUP:[52,3,1,""],STS_USER:[52,3,1,""]},"com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters":{FilterSpec:[52,1,1,""],Info:[52,1,1,""],State:[52,1,1,""],Summary:[52,1,1,""],UpdateSpec:[52,1,1,""],get:[52,2,1,""],list:[52,2,1,""],update_task:[52,2,1,""]},"com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State":{DISABLE:[52,3,1,""],ENABLE:[52,3,1,""]},"com.vmware.vcenter.vcha":{cluster_client:[96,0,0,"-"]},"com.vmware.vcenter.vcha.cluster_client":{Active:[96,1,1,""],DeploymentType:[96,1,1,""],Mode:[96,1,1,""],Passive:[96,1,1,""],StubFactory:[96,1,1,""],Witness:[96,1,1,""]},"com.vmware.vcenter.vcha.cluster_client.Active":{Info:[96,1,1,""],get:[96,2,1,""]},"com.vmware.vcenter.vcha.cluster_client.DeploymentType":{Info:[96,1,1,""],Type:[96,1,1,""],get:[96,2,1,""]},"com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type":{AUTO:[96,3,1,""],MANUAL:[96,3,1,""],NONE:[96,3,1,""]},"com.vmware.vcenter.vcha.cluster_client.Mode":{ClusterMode:[96,1,1,""],Info:[96,1,1,""],get:[96,2,1,""],set_task:[96,2,1,""]},"com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode":{DISABLED:[96,3,1,""],ENABLED:[96,3,1,""],MAINTENANCE:[96,3,1,""]},"com.vmware.vcenter.vcha.cluster_client.Passive":{CheckResult:[96,1,1,""],CheckSpec:[96,1,1,""],RedeploySpec:[96,1,1,""],check:[96,2,1,""],redeploy_task:[96,2,1,""]},"com.vmware.vcenter.vcha.cluster_client.Witness":{CheckResult:[96,1,1,""],CheckSpec:[96,1,1,""],RedeploySpec:[96,1,1,""],check:[96,2,1,""],redeploy_task:[96,2,1,""]},"com.vmware.vcenter.vcha_client":{CertificateInfo:[52,1,1,""],Cluster:[52,1,1,""],ConnectionSpec:[52,1,1,""],CredentialsSpec:[52,1,1,""],DiskInfo:[52,1,1,""],DiskSpec:[52,1,1,""],IpFamily:[52,1,1,""],IpSpec:[52,1,1,""],Ipv4Spec:[52,1,1,""],Ipv6Spec:[52,1,1,""],NetworkType:[52,1,1,""],Operations:[52,1,1,""],PlacementInfo:[52,1,1,""],PlacementSpec:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.vcha_client.Cluster":{ActiveSpec:[52,1,1,""],ClusterMode:[52,1,1,""],ClusterState:[52,1,1,""],ConfigState:[52,1,1,""],DeploySpec:[52,1,1,""],ErrorCondition:[52,1,1,""],Info:[52,1,1,""],IpFamily:[52,1,1,""],IpInfo:[52,1,1,""],Ipv4Info:[52,1,1,""],Ipv6Info:[52,1,1,""],NodeInfo:[52,1,1,""],NodeRole:[52,1,1,""],NodeRuntimeInfo:[52,1,1,""],NodeState:[52,1,1,""],NodeVmInfo:[52,1,1,""],PassiveSpec:[52,1,1,""],Type:[52,1,1,""],UndeploySpec:[52,1,1,""],VmInfo:[52,1,1,""],WitnessInfo:[52,1,1,""],WitnessSpec:[52,1,1,""],deploy_task:[52,2,1,""],failover_task:[52,2,1,""],get:[52,2,1,""],undeploy_task:[52,2,1,""]},"com.vmware.vcenter.vcha_client.Cluster.ClusterMode":{DISABLED:[52,3,1,""],ENABLED:[52,3,1,""],MAINTENANCE:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Cluster.ClusterState":{DEGRADED:[52,3,1,""],HEALTHY:[52,3,1,""],ISOLATED:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Cluster.ConfigState":{CONFIGURED:[52,3,1,""],INVALID:[52,3,1,""],NOTCONFIGURED:[52,3,1,""],PREPARED:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Cluster.IpFamily":{IPV4:[52,3,1,""],IPV6:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Cluster.NodeRole":{ACTIVE:[52,3,1,""],PASSIVE:[52,3,1,""],WITNESS:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Cluster.NodeState":{DOWN:[52,3,1,""],UP:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Cluster.Type":{AUTO:[52,3,1,""],MANUAL:[52,3,1,""]},"com.vmware.vcenter.vcha_client.IpFamily":{IPV4:[52,3,1,""],IPV6:[52,3,1,""]},"com.vmware.vcenter.vcha_client.NetworkType":{DISTRIBUTED_PORTGROUP:[52,3,1,""],STANDARD_PORTGROUP:[52,3,1,""]},"com.vmware.vcenter.vcha_client.Operations":{CLUSTER_DEPLOY_OP:[52,3,1,""],CLUSTER_FAILOVER_OP:[52,3,1,""],CLUSTER_GET_OP:[52,3,1,""],CLUSTER_UNDEPLOY_OP:[52,3,1,""],Info:[52,1,1,""],MODE_GET_OP:[52,3,1,""],MODE_SET_OP:[52,3,1,""],PASSIVE_REDEPLOY_OP:[52,3,1,""],WITNESS_REDEPLOY_OP:[52,3,1,""],get:[52,2,1,""]},"com.vmware.vcenter.vm":{compute_client:[97,0,0,"-"],console_client:[97,0,0,"-"],data_sets_client:[97,0,0,"-"],guest:[98,0,0,"-"],guest_client:[97,0,0,"-"],hardware:[99,0,0,"-"],hardware_client:[97,0,0,"-"],storage:[100,0,0,"-"],storage_client:[97,0,0,"-"],tools_client:[97,0,0,"-"]},"com.vmware.vcenter.vm.compute_client":{Policies:[97,1,1,""],StubFactory:[97,1,1,""]},"com.vmware.vcenter.vm.compute_client.Policies":{Info:[97,1,1,""],get:[97,2,1,""]},"com.vmware.vcenter.vm.console_client":{StubFactory:[97,1,1,""],Tickets:[97,1,1,""]},"com.vmware.vcenter.vm.console_client.Tickets":{CreateSpec:[97,1,1,""],Summary:[97,1,1,""],Type:[97,1,1,""],create:[97,2,1,""]},"com.vmware.vcenter.vm.console_client.Tickets.Type":{VMRC:[97,3,1,""],WEBMKS:[97,3,1,""]},"com.vmware.vcenter.vm.data_sets_client":{Entries:[97,1,1,""],StubFactory:[97,1,1,""]},"com.vmware.vcenter.vm.data_sets_client.Entries":{"delete":[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],set:[97,2,1,""]},"com.vmware.vcenter.vm.guest":{filesystem_client:[98,0,0,"-"],networking_client:[98,0,0,"-"]},"com.vmware.vcenter.vm.guest.filesystem_client":{Directories:[98,1,1,""],ErrorReason:[98,1,1,""],FileErrorDetails:[98,1,1,""],Files:[98,1,1,""],StubFactory:[98,1,1,""],Transfers:[98,1,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.Directories":{"delete":[98,2,1,""],create:[98,2,1,""],create_temporary:[98,2,1,""],move:[98,2,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.ErrorReason":{DIRECTORY_NOT_EMPTY:[98,3,1,""],FILE_NOT_FOUND:[98,3,1,""],FILE_TOO_LARGE:[98,3,1,""],NOT_A_DIRECTORY:[98,3,1,""],NOT_A_FILE:[98,3,1,""],NO_DISK_SPACE:[98,3,1,""],PATH_TOO_LONG:[98,3,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.Files":{"delete":[98,2,1,""],FileAttributesInfo:[98,1,1,""],FileAttributesUpdateSpec:[98,1,1,""],FilesystemFamily:[98,1,1,""],FilterSpec:[98,1,1,""],Info:[98,1,1,""],IterationSpec:[98,1,1,""],LastIterationStatus:[98,1,1,""],ListResult:[98,1,1,""],PosixFileAttributesInfo:[98,1,1,""],PosixFileAttributesUpdateSpec:[98,1,1,""],Summary:[98,1,1,""],Type:[98,1,1,""],WindowsFileAttributesInfo:[98,1,1,""],WindowsFileAttributesUpdateSpec:[98,1,1,""],create_temporary:[98,2,1,""],get:[98,2,1,""],list:[98,2,1,""],move:[98,2,1,""],update:[98,2,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.Files.FilesystemFamily":{POSIX:[98,3,1,""],WINDOWS:[98,3,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.Files.LastIterationStatus":{END_OF_DATA:[98,3,1,""],READY:[98,3,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.Files.Type":{DIRECTORY:[98,3,1,""],FILE:[98,3,1,""],SYMLINK:[98,3,1,""]},"com.vmware.vcenter.vm.guest.filesystem_client.Transfers":{CreateSpec:[98,1,1,""],FileCreationAttributes:[98,1,1,""],PosixFileAttributesCreateSpec:[98,1,1,""],WindowsFileAttributesCreateSpec:[98,1,1,""],create:[98,2,1,""]},"com.vmware.vcenter.vm.guest.networking_client":{Interfaces:[98,1,1,""],Routes:[98,1,1,""],StubFactory:[98,1,1,""]},"com.vmware.vcenter.vm.guest.networking_client.Interfaces":{Info:[98,1,1,""],IpAddressInfo:[98,1,1,""],IpAddressOrigin:[98,1,1,""],IpAddressStatus:[98,1,1,""],IpConfigInfo:[98,1,1,""],list:[98,2,1,""]},"com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressOrigin":{DHCP:[98,3,1,""],LINKLAYER:[98,3,1,""],MANUAL:[98,3,1,""],OTHER:[98,3,1,""],RANDOM:[98,3,1,""]},"com.vmware.vcenter.vm.guest.networking_client.Interfaces.IpAddressStatus":{DEPRECATED:[98,3,1,""],DUPLICATE:[98,3,1,""],INACCESSIBLE:[98,3,1,""],INVALID:[98,3,1,""],PREFERRED:[98,3,1,""],TENTATIVE:[98,3,1,""],UNKNOWN:[98,3,1,""]},"com.vmware.vcenter.vm.guest.networking_client.Routes":{Info:[98,1,1,""],list:[98,2,1,""]},"com.vmware.vcenter.vm.guest_client":{Credentials:[97,1,1,""],Customization:[97,1,1,""],DhcpConfigInfo:[97,1,1,""],DnsAssignedValues:[97,1,1,""],DnsConfigInfo:[97,1,1,""],Environment:[97,1,1,""],Identity:[97,1,1,""],LocalFilesystem:[97,1,1,""],Networking:[97,1,1,""],Operations:[97,1,1,""],Power:[97,1,1,""],Processes:[97,1,1,""],StubFactory:[97,1,1,""]},"com.vmware.vcenter.vm.guest_client.Credentials":{Type:[97,1,1,""]},"com.vmware.vcenter.vm.guest_client.Credentials.Type":{SAML_BEARER_TOKEN:[97,3,1,""],USERNAME_PASSWORD:[97,3,1,""]},"com.vmware.vcenter.vm.guest_client.Customization":{Info:[97,1,1,""],SetSpec:[97,1,1,""],get:[97,2,1,""],set:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.Customization.Info":{Status:[97,1,1,""]},"com.vmware.vcenter.vm.guest_client.Customization.Info.Status":{FAILED:[97,3,1,""],IDLE:[97,3,1,""],PENDING:[97,3,1,""],RUNNING:[97,3,1,""],SUCCEEDED:[97,3,1,""]},"com.vmware.vcenter.vm.guest_client.Environment":{get:[97,2,1,""],list:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.Identity":{Info:[97,1,1,""],get:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.LocalFilesystem":{Info:[97,1,1,""],VirtualDiskMapping:[97,1,1,""],get:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.Networking":{Info:[97,1,1,""],get:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.Operations":{Info:[97,1,1,""],get:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.Power":{Info:[97,1,1,""],State:[97,1,1,""],get:[97,2,1,""],reboot:[97,2,1,""],shutdown:[97,2,1,""],standby:[97,2,1,""]},"com.vmware.vcenter.vm.guest_client.Power.State":{NOT_RUNNING:[97,3,1,""],RESETTING:[97,3,1,""],RUNNING:[97,3,1,""],SHUTTING_DOWN:[97,3,1,""],STANDBY:[97,3,1,""],UNAVAILABLE:[97,3,1,""]},"com.vmware.vcenter.vm.guest_client.Processes":{"delete":[97,2,1,""],CreateSpec:[97,1,1,""],Info:[97,1,1,""],ProcessErrorDetails:[97,1,1,""],Summary:[97,1,1,""],create:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""]},"com.vmware.vcenter.vm.hardware":{adapter_client:[99,0,0,"-"],boot_client:[99,0,0,"-"]},"com.vmware.vcenter.vm.hardware.adapter_client":{Nvme:[99,1,1,""],Sata:[99,1,1,""],Scsi:[99,1,1,""],StubFactory:[99,1,1,""]},"com.vmware.vcenter.vm.hardware.adapter_client.Nvme":{"delete":[99,2,1,""],CreateSpec:[99,1,1,""],Info:[99,1,1,""],RESOURCE_TYPE:[99,3,1,""],Summary:[99,1,1,""],create:[99,2,1,""],get:[99,2,1,""],list:[99,2,1,""]},"com.vmware.vcenter.vm.hardware.adapter_client.Sata":{"delete":[99,2,1,""],CreateSpec:[99,1,1,""],Info:[99,1,1,""],RESOURCE_TYPE:[99,3,1,""],Summary:[99,1,1,""],Type:[99,1,1,""],create:[99,2,1,""],get:[99,2,1,""],list:[99,2,1,""]},"com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type":{AHCI:[99,3,1,""]},"com.vmware.vcenter.vm.hardware.adapter_client.Scsi":{"delete":[99,2,1,""],CreateSpec:[99,1,1,""],Info:[99,1,1,""],RESOURCE_TYPE:[99,3,1,""],Sharing:[99,1,1,""],Summary:[99,1,1,""],Type:[99,1,1,""],UpdateSpec:[99,1,1,""],create:[99,2,1,""],get:[99,2,1,""],list:[99,2,1,""],update:[99,2,1,""]},"com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing":{NONE:[99,3,1,""],PHYSICAL:[99,3,1,""],VIRTUAL:[99,3,1,""]},"com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type":{BUSLOGIC:[99,3,1,""],LSILOGIC:[99,3,1,""],LSILOGICSAS:[99,3,1,""],PVSCSI:[99,3,1,""]},"com.vmware.vcenter.vm.hardware.boot_client":{Device:[99,1,1,""],StubFactory:[99,1,1,""]},"com.vmware.vcenter.vm.hardware.boot_client.Device":{Entry:[99,1,1,""],EntryCreateSpec:[99,1,1,""],Type:[99,1,1,""],get:[99,2,1,""],set:[99,2,1,""]},"com.vmware.vcenter.vm.hardware.boot_client.Device.Type":{CDROM:[99,3,1,""],DISK:[99,3,1,""],ETHERNET:[99,3,1,""],FLOPPY:[99,3,1,""]},"com.vmware.vcenter.vm.hardware_client":{Boot:[97,1,1,""],Cdrom:[97,1,1,""],ConnectionCreateSpec:[97,1,1,""],ConnectionInfo:[97,1,1,""],ConnectionState:[97,1,1,""],ConnectionUpdateSpec:[97,1,1,""],Cpu:[97,1,1,""],Disk:[97,1,1,""],Ethernet:[97,1,1,""],Floppy:[97,1,1,""],IdeAddressInfo:[97,1,1,""],IdeAddressSpec:[97,1,1,""],Memory:[97,1,1,""],NvmeAddressInfo:[97,1,1,""],NvmeAddressSpec:[97,1,1,""],Parallel:[97,1,1,""],SataAddressInfo:[97,1,1,""],SataAddressSpec:[97,1,1,""],ScsiAddressInfo:[97,1,1,""],ScsiAddressSpec:[97,1,1,""],Serial:[97,1,1,""],StubFactory:[97,1,1,""]},"com.vmware.vcenter.vm.hardware_client.Boot":{CreateSpec:[97,1,1,""],Info:[97,1,1,""],NetworkProtocol:[97,1,1,""],Type:[97,1,1,""],UpdateSpec:[97,1,1,""],get:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol":{IPV4:[97,3,1,""],IPV6:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Boot.Type":{BIOS:[97,3,1,""],EFI:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Cdrom":{"delete":[97,2,1,""],BackingInfo:[97,1,1,""],BackingSpec:[97,1,1,""],BackingType:[97,1,1,""],CreateSpec:[97,1,1,""],DeviceAccessType:[97,1,1,""],HostBusAdapterType:[97,1,1,""],Info:[97,1,1,""],RESOURCE_TYPE:[97,3,1,""],Summary:[97,1,1,""],UpdateSpec:[97,1,1,""],connect:[97,2,1,""],create:[97,2,1,""],disconnect:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType":{CLIENT_DEVICE:[97,3,1,""],HOST_DEVICE:[97,3,1,""],ISO_FILE:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType":{EMULATION:[97,3,1,""],PASSTHRU:[97,3,1,""],PASSTHRU_EXCLUSIVE:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType":{IDE:[97,3,1,""],SATA:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.ConnectionState":{CONNECTED:[97,3,1,""],NOT_CONNECTED:[97,3,1,""],RECOVERABLE_ERROR:[97,3,1,""],UNKNOWN:[97,3,1,""],UNRECOVERABLE_ERROR:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Cpu":{Info:[97,1,1,""],UpdateSpec:[97,1,1,""],get:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Disk":{"delete":[97,2,1,""],BackingInfo:[97,1,1,""],BackingSpec:[97,1,1,""],BackingType:[97,1,1,""],CreateSpec:[97,1,1,""],HostBusAdapterType:[97,1,1,""],Info:[97,1,1,""],RESOURCE_TYPE:[97,3,1,""],StoragePolicySpec:[97,1,1,""],Summary:[97,1,1,""],UpdateSpec:[97,1,1,""],VmdkCreateSpec:[97,1,1,""],create:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Disk.BackingType":{VMDK_FILE:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType":{IDE:[97,3,1,""],NVME:[97,3,1,""],SATA:[97,3,1,""],SCSI:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Ethernet":{"delete":[97,2,1,""],BackingInfo:[97,1,1,""],BackingSpec:[97,1,1,""],BackingType:[97,1,1,""],CreateSpec:[97,1,1,""],EmulationType:[97,1,1,""],Info:[97,1,1,""],MacAddressType:[97,1,1,""],RESOURCE_TYPE:[97,3,1,""],Summary:[97,1,1,""],UpdateSpec:[97,1,1,""],connect:[97,2,1,""],create:[97,2,1,""],disconnect:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType":{DISTRIBUTED_PORTGROUP:[97,3,1,""],HOST_DEVICE:[97,3,1,""],OPAQUE_NETWORK:[97,3,1,""],STANDARD_PORTGROUP:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType":{E1000:[97,3,1,""],E1000E:[97,3,1,""],PCNET32:[97,3,1,""],VMXNET2:[97,3,1,""],VMXNET3:[97,3,1,""],VMXNET:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType":{ASSIGNED:[97,3,1,""],GENERATED:[97,3,1,""],MANUAL:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Floppy":{"delete":[97,2,1,""],BackingInfo:[97,1,1,""],BackingSpec:[97,1,1,""],BackingType:[97,1,1,""],CreateSpec:[97,1,1,""],Info:[97,1,1,""],RESOURCE_TYPE:[97,3,1,""],Summary:[97,1,1,""],UpdateSpec:[97,1,1,""],connect:[97,2,1,""],create:[97,2,1,""],disconnect:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Floppy.BackingType":{CLIENT_DEVICE:[97,3,1,""],HOST_DEVICE:[97,3,1,""],IMAGE_FILE:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Memory":{Info:[97,1,1,""],UpdateSpec:[97,1,1,""],get:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Parallel":{"delete":[97,2,1,""],BackingInfo:[97,1,1,""],BackingSpec:[97,1,1,""],BackingType:[97,1,1,""],CreateSpec:[97,1,1,""],Info:[97,1,1,""],RESOURCE_TYPE:[97,3,1,""],Summary:[97,1,1,""],UpdateSpec:[97,1,1,""],connect:[97,2,1,""],create:[97,2,1,""],disconnect:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Parallel.BackingType":{FILE:[97,3,1,""],HOST_DEVICE:[97,3,1,""]},"com.vmware.vcenter.vm.hardware_client.Serial":{"delete":[97,2,1,""],BackingInfo:[97,1,1,""],BackingSpec:[97,1,1,""],BackingType:[97,1,1,""],CreateSpec:[97,1,1,""],Info:[97,1,1,""],RESOURCE_TYPE:[97,3,1,""],Summary:[97,1,1,""],UpdateSpec:[97,1,1,""],connect:[97,2,1,""],create:[97,2,1,""],disconnect:[97,2,1,""],get:[97,2,1,""],list:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.hardware_client.Serial.BackingType":{FILE:[97,3,1,""],HOST_DEVICE:[97,3,1,""],NETWORK_CLIENT:[97,3,1,""],NETWORK_SERVER:[97,3,1,""],PIPE_CLIENT:[97,3,1,""],PIPE_SERVER:[97,3,1,""]},"com.vmware.vcenter.vm.storage":{policy_client:[100,0,0,"-"]},"com.vmware.vcenter.vm.storage.policy_client":{Compliance:[100,1,1,""],StubFactory:[100,1,1,""]},"com.vmware.vcenter.vm.storage.policy_client.Compliance":{CheckSpec:[100,1,1,""],Info:[100,1,1,""],Status:[100,1,1,""],VmComplianceInfo:[100,1,1,""],check:[100,2,1,""],get:[100,2,1,""]},"com.vmware.vcenter.vm.storage.policy_client.Compliance.Status":{COMPLIANT:[100,3,1,""],NON_COMPLIANT:[100,3,1,""],NOT_APPLICABLE:[100,3,1,""],OUT_OF_DATE:[100,3,1,""],UNKNOWN_COMPLIANCE:[100,3,1,""]},"com.vmware.vcenter.vm.storage_client":{Policy:[97,1,1,""],StubFactory:[97,1,1,""]},"com.vmware.vcenter.vm.storage_client.Policy":{DiskPolicySpec:[97,1,1,""],Info:[97,1,1,""],UpdateSpec:[97,1,1,""],VmHomePolicySpec:[97,1,1,""],get:[97,2,1,""],update:[97,2,1,""]},"com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec":{PolicyType:[97,1,1,""]},"com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType":{USE_DEFAULT_POLICY:[97,3,1,""],USE_SPECIFIED_POLICY:[97,3,1,""]},"com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec":{PolicyType:[97,1,1,""]},"com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType":{USE_DEFAULT_POLICY:[97,3,1,""],USE_SPECIFIED_POLICY:[97,3,1,""]},"com.vmware.vcenter.vm.tools_client":{Installer:[97,1,1,""],StubFactory:[97,1,1,""]},"com.vmware.vcenter.vm.tools_client.Installer":{Info:[97,1,1,""],connect:[97,2,1,""],disconnect:[97,2,1,""],get:[97,2,1,""]},"com.vmware.vcenter.vm_client":{DataSets:[52,1,1,""],GuestOS:[52,1,1,""],GuestOSFamily:[52,1,1,""],Hardware:[52,1,1,""],Identity:[52,1,1,""],LibraryItem:[52,1,1,""],Power:[52,1,1,""],StubFactory:[52,1,1,""],Tools:[52,1,1,""]},"com.vmware.vcenter.vm_client.DataSets":{"delete":[52,2,1,""],Access:[52,1,1,""],CreateSpec:[52,1,1,""],Info:[52,1,1,""],Summary:[52,1,1,""],UpdateSpec:[52,1,1,""],create:[52,2,1,""],get:[52,2,1,""],list:[52,2,1,""],update:[52,2,1,""]},"com.vmware.vcenter.vm_client.DataSets.Access":{NONE:[52,3,1,""],READ_ONLY:[52,3,1,""],READ_WRITE:[52,3,1,""]},"com.vmware.vcenter.vm_client.GuestOS":{ALMALINUX_64:[52,3,1,""],AMAZONLINUX2_64:[52,3,1,""],AMAZONLINUX3_64:[52,3,1,""],ASIANUX_3:[52,3,1,""],ASIANUX_3_64:[52,3,1,""],ASIANUX_4:[52,3,1,""],ASIANUX_4_64:[52,3,1,""],ASIANUX_5_64:[52,3,1,""],ASIANUX_7_64:[52,3,1,""],ASIANUX_8_64:[52,3,1,""],ASIANUX_9_64:[52,3,1,""],CENTOS:[52,3,1,""],CENTOS_64:[52,3,1,""],CENTOS_6:[52,3,1,""],CENTOS_6_64:[52,3,1,""],CENTOS_7:[52,3,1,""],CENTOS_7_64:[52,3,1,""],CENTOS_8_64:[52,3,1,""],CENTOS_9_64:[52,3,1,""],COREOS_64:[52,3,1,""],CRXPOD_1:[52,3,1,""],DARWIN:[52,3,1,""],DARWIN_10:[52,3,1,""],DARWIN_10_64:[52,3,1,""],DARWIN_11:[52,3,1,""],DARWIN_11_64:[52,3,1,""],DARWIN_12_64:[52,3,1,""],DARWIN_13_64:[52,3,1,""],DARWIN_14_64:[52,3,1,""],DARWIN_15_64:[52,3,1,""],DARWIN_16_64:[52,3,1,""],DARWIN_17_64:[52,3,1,""],DARWIN_18_64:[52,3,1,""],DARWIN_19_64:[52,3,1,""],DARWIN_20_64:[52,3,1,""],DARWIN_21_64:[52,3,1,""],DARWIN_22_64:[52,3,1,""],DARWIN_23_64:[52,3,1,""],DARWIN_64:[52,3,1,""],DEBIAN_10:[52,3,1,""],DEBIAN_10_64:[52,3,1,""],DEBIAN_11:[52,3,1,""],DEBIAN_11_64:[52,3,1,""],DEBIAN_12:[52,3,1,""],DEBIAN_12_64:[52,3,1,""],DEBIAN_4:[52,3,1,""],DEBIAN_4_64:[52,3,1,""],DEBIAN_5:[52,3,1,""],DEBIAN_5_64:[52,3,1,""],DEBIAN_6:[52,3,1,""],DEBIAN_6_64:[52,3,1,""],DEBIAN_7:[52,3,1,""],DEBIAN_7_64:[52,3,1,""],DEBIAN_8:[52,3,1,""],DEBIAN_8_64:[52,3,1,""],DEBIAN_9:[52,3,1,""],DEBIAN_9_64:[52,3,1,""],DOS:[52,3,1,""],ECOMSTATION:[52,3,1,""],ECOMSTATION_2:[52,3,1,""],FEDORA:[52,3,1,""],FEDORA_64:[52,3,1,""],FREEBSD:[52,3,1,""],FREEBSD_11:[52,3,1,""],FREEBSD_11_64:[52,3,1,""],FREEBSD_12:[52,3,1,""],FREEBSD_12_64:[52,3,1,""],FREEBSD_13:[52,3,1,""],FREEBSD_13_64:[52,3,1,""],FREEBSD_14:[52,3,1,""],FREEBSD_14_64:[52,3,1,""],FREEBSD_64:[52,3,1,""],GENERIC_LINUX:[52,3,1,""],MANDRAKE:[52,3,1,""],MANDRIVA:[52,3,1,""],MANDRIVA_64:[52,3,1,""],NETWARE_4:[52,3,1,""],NETWARE_5:[52,3,1,""],NETWARE_6:[52,3,1,""],NLD_9:[52,3,1,""],OES:[52,3,1,""],OPENSERVER_5:[52,3,1,""],OPENSERVER_6:[52,3,1,""],OPENSUSE:[52,3,1,""],OPENSUSE_64:[52,3,1,""],ORACLE_LINUX:[52,3,1,""],ORACLE_LINUX_64:[52,3,1,""],ORACLE_LINUX_6:[52,3,1,""],ORACLE_LINUX_6_64:[52,3,1,""],ORACLE_LINUX_7:[52,3,1,""],ORACLE_LINUX_7_64:[52,3,1,""],ORACLE_LINUX_8_64:[52,3,1,""],ORACLE_LINUX_9_64:[52,3,1,""],OS2:[52,3,1,""],OTHER:[52,3,1,""],OTHER_24X_LINUX:[52,3,1,""],OTHER_24X_LINUX_64:[52,3,1,""],OTHER_26X_LINUX:[52,3,1,""],OTHER_26X_LINUX_64:[52,3,1,""],OTHER_3X_LINUX:[52,3,1,""],OTHER_3X_LINUX_64:[52,3,1,""],OTHER_4X_LINUX:[52,3,1,""],OTHER_4X_LINUX_64:[52,3,1,""],OTHER_5X_LINUX:[52,3,1,""],OTHER_5X_LINUX_64:[52,3,1,""],OTHER_64:[52,3,1,""],OTHER_6X_LINUX:[52,3,1,""],OTHER_6X_LINUX_64:[52,3,1,""],OTHER_LINUX:[52,3,1,""],OTHER_LINUX_64:[52,3,1,""],REDHAT:[52,3,1,""],RHEL_2:[52,3,1,""],RHEL_3:[52,3,1,""],RHEL_3_64:[52,3,1,""],RHEL_4:[52,3,1,""],RHEL_4_64:[52,3,1,""],RHEL_5:[52,3,1,""],RHEL_5_64:[52,3,1,""],RHEL_6:[52,3,1,""],RHEL_6_64:[52,3,1,""],RHEL_7:[52,3,1,""],RHEL_7_64:[52,3,1,""],RHEL_8_64:[52,3,1,""],RHEL_9_64:[52,3,1,""],ROCKYLINUX_64:[52,3,1,""],SJDS:[52,3,1,""],SLES:[52,3,1,""],SLES_10:[52,3,1,""],SLES_10_64:[52,3,1,""],SLES_11:[52,3,1,""],SLES_11_64:[52,3,1,""],SLES_12:[52,3,1,""],SLES_12_64:[52,3,1,""],SLES_15_64:[52,3,1,""],SLES_16_64:[52,3,1,""],SLES_64:[52,3,1,""],SOLARIS_10:[52,3,1,""],SOLARIS_10_64:[52,3,1,""],SOLARIS_11_64:[52,3,1,""],SOLARIS_6:[52,3,1,""],SOLARIS_7:[52,3,1,""],SOLARIS_8:[52,3,1,""],SOLARIS_9:[52,3,1,""],SUSE:[52,3,1,""],SUSE_64:[52,3,1,""],TURBO_LINUX:[52,3,1,""],TURBO_LINUX_64:[52,3,1,""],UBUNTU:[52,3,1,""],UBUNTU_64:[52,3,1,""],UNIXWARE_7:[52,3,1,""],VMKERNEL:[52,3,1,""],VMKERNEL_5:[52,3,1,""],VMKERNEL_65:[52,3,1,""],VMKERNEL_6:[52,3,1,""],VMKERNEL_7:[52,3,1,""],VMKERNEL_8:[52,3,1,""],VMWARE_PHOTON_64:[52,3,1,""],WINDOWS_11_64:[52,3,1,""],WINDOWS_12_64:[52,3,1,""],WINDOWS_7:[52,3,1,""],WINDOWS_7_64:[52,3,1,""],WINDOWS_7_SERVER_64:[52,3,1,""],WINDOWS_8:[52,3,1,""],WINDOWS_8_64:[52,3,1,""],WINDOWS_8_SERVER_64:[52,3,1,""],WINDOWS_9:[52,3,1,""],WINDOWS_9_64:[52,3,1,""],WINDOWS_9_SERVER_64:[52,3,1,""],WINDOWS_HYPERV:[52,3,1,""],WINDOWS_SERVER_2019:[52,3,1,""],WINDOWS_SERVER_2021:[52,3,1,""],WINDOWS_SERVER_2025:[52,3,1,""],WIN_2000_ADV_SERV:[52,3,1,""],WIN_2000_PRO:[52,3,1,""],WIN_2000_SERV:[52,3,1,""],WIN_31:[52,3,1,""],WIN_95:[52,3,1,""],WIN_98:[52,3,1,""],WIN_LONGHORN:[52,3,1,""],WIN_LONGHORN_64:[52,3,1,""],WIN_ME:[52,3,1,""],WIN_NET_BUSINESS:[52,3,1,""],WIN_NET_DATACENTER:[52,3,1,""],WIN_NET_DATACENTER_64:[52,3,1,""],WIN_NET_ENTERPRISE:[52,3,1,""],WIN_NET_ENTERPRISE_64:[52,3,1,""],WIN_NET_STANDARD:[52,3,1,""],WIN_NET_STANDARD_64:[52,3,1,""],WIN_NET_WEB:[52,3,1,""],WIN_NT:[52,3,1,""],WIN_VISTA:[52,3,1,""],WIN_VISTA_64:[52,3,1,""],WIN_XP_HOME:[52,3,1,""],WIN_XP_PRO:[52,3,1,""],WIN_XP_PRO_64:[52,3,1,""]},"com.vmware.vcenter.vm_client.GuestOSFamily":{DARWIN:[52,3,1,""],LINUX:[52,3,1,""],NETWARE:[52,3,1,""],OTHER:[52,3,1,""],SOLARIS:[52,3,1,""],WINDOWS:[52,3,1,""]},"com.vmware.vcenter.vm_client.Hardware":{Info:[52,1,1,""],UpdateSpec:[52,1,1,""],UpgradePolicy:[52,1,1,""],UpgradeStatus:[52,1,1,""],Version:[52,1,1,""],get:[52,2,1,""],update:[52,2,1,""],upgrade:[52,2,1,""]},"com.vmware.vcenter.vm_client.Hardware.UpgradePolicy":{AFTER_CLEAN_SHUTDOWN:[52,3,1,""],ALWAYS:[52,3,1,""],NEVER:[52,3,1,""]},"com.vmware.vcenter.vm_client.Hardware.UpgradeStatus":{FAILED:[52,3,1,""],NONE:[52,3,1,""],PENDING:[52,3,1,""],SUCCESS:[52,3,1,""]},"com.vmware.vcenter.vm_client.Hardware.Version":{VMX_03:[52,3,1,""],VMX_04:[52,3,1,""],VMX_06:[52,3,1,""],VMX_07:[52,3,1,""],VMX_08:[52,3,1,""],VMX_09:[52,3,1,""],VMX_10:[52,3,1,""],VMX_11:[52,3,1,""],VMX_12:[52,3,1,""],VMX_13:[52,3,1,""],VMX_14:[52,3,1,""],VMX_15:[52,3,1,""],VMX_16:[52,3,1,""],VMX_17:[52,3,1,""],VMX_18:[52,3,1,""],VMX_19:[52,3,1,""],VMX_20:[52,3,1,""],VMX_21:[52,3,1,""]},"com.vmware.vcenter.vm_client.Identity":{Info:[52,1,1,""]},"com.vmware.vcenter.vm_client.LibraryItem":{CheckOutInfo:[52,1,1,""],Info:[52,1,1,""],get:[52,2,1,""]},"com.vmware.vcenter.vm_client.Power":{Info:[52,1,1,""],State:[52,1,1,""],get:[52,2,1,""],reset:[52,2,1,""],start:[52,2,1,""],stop:[52,2,1,""],suspend:[52,2,1,""]},"com.vmware.vcenter.vm_client.Power.State":{POWERED_OFF:[52,3,1,""],POWERED_ON:[52,3,1,""],SUSPENDED:[52,3,1,""]},"com.vmware.vcenter.vm_client.Tools":{Info:[52,1,1,""],RunState:[52,1,1,""],ToolsInstallType:[52,1,1,""],UpdateSpec:[52,1,1,""],UpgradePolicy:[52,1,1,""],VersionStatus:[52,1,1,""],get:[52,2,1,""],update:[52,2,1,""],upgrade:[52,2,1,""]},"com.vmware.vcenter.vm_client.Tools.RunState":{EXECUTING_SCRIPTS:[52,3,1,""],NOT_RUNNING:[52,3,1,""],RUNNING:[52,3,1,""]},"com.vmware.vcenter.vm_client.Tools.ToolsInstallType":{MSI:[52,3,1,""],OPEN_VM_TOOLS:[52,3,1,""],OSP:[52,3,1,""],TAR:[52,3,1,""],UNKNOWN:[52,3,1,""]},"com.vmware.vcenter.vm_client.Tools.UpgradePolicy":{MANUAL:[52,3,1,""],UPGRADE_AT_POWER_CYCLE:[52,3,1,""]},"com.vmware.vcenter.vm_client.Tools.VersionStatus":{BLACKLISTED:[52,3,1,""],CURRENT:[52,3,1,""],NOT_INSTALLED:[52,3,1,""],SUPPORTED_NEW:[52,3,1,""],SUPPORTED_OLD:[52,3,1,""],TOO_NEW:[52,3,1,""],TOO_OLD_UNSUPPORTED:[52,3,1,""],UNMANAGED:[52,3,1,""]},"com.vmware.vcenter.vm_template":{library_items_client:[101,0,0,"-"]},"com.vmware.vcenter.vm_template.library_items_client":{CheckOuts:[101,1,1,""],StubFactory:[101,1,1,""],Versions:[101,1,1,""]},"com.vmware.vcenter.vm_template.library_items_client.CheckOuts":{"delete":[101,2,1,""],CheckInSpec:[101,1,1,""],CheckOutSpec:[101,1,1,""],Info:[101,1,1,""],PlacementSpec:[101,1,1,""],Summary:[101,1,1,""],check_in:[101,2,1,""],check_out:[101,2,1,""],get:[101,2,1,""],list:[101,2,1,""]},"com.vmware.vcenter.vm_template.library_items_client.Versions":{"delete":[101,2,1,""],Info:[101,1,1,""],RESOURCE_TYPE:[101,3,1,""],RollbackSpec:[101,1,1,""],Summary:[101,1,1,""],get:[101,2,1,""],list:[101,2,1,""],rollback:[101,2,1,""]},"com.vmware.vcenter.vm_template_client":{LibraryItems:[52,1,1,""],StubFactory:[52,1,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems":{CpuInfo:[52,1,1,""],CpuUpdateSpec:[52,1,1,""],CreatePlacementSpec:[52,1,1,""],CreateSpec:[52,1,1,""],CreateSpecDiskStorage:[52,1,1,""],CreateSpecDiskStoragePolicy:[52,1,1,""],CreateSpecVmHomeStorage:[52,1,1,""],CreateSpecVmHomeStoragePolicy:[52,1,1,""],DeployPlacementSpec:[52,1,1,""],DeploySpec:[52,1,1,""],DeploySpecDiskStorage:[52,1,1,""],DeploySpecDiskStoragePolicy:[52,1,1,""],DeploySpecVmHomeStorage:[52,1,1,""],DeploySpecVmHomeStoragePolicy:[52,1,1,""],DiskInfo:[52,1,1,""],DiskStorageInfo:[52,1,1,""],DiskUpdateSpec:[52,1,1,""],EthernetInfo:[52,1,1,""],EthernetUpdateSpec:[52,1,1,""],GuestCustomizationSpec:[52,1,1,""],HardwareCustomizationSpec:[52,1,1,""],Info:[52,1,1,""],MemoryInfo:[52,1,1,""],MemoryUpdateSpec:[52,1,1,""],VmHomeStorageInfo:[52,1,1,""],create:[52,2,1,""],deploy:[52,2,1,""],get:[52,2,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy":{Type:[52,1,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type":{USE_SPECIFIED_POLICY:[52,3,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy":{Type:[52,1,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type":{USE_SPECIFIED_POLICY:[52,3,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy":{Type:[52,1,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type":{USE_SOURCE_POLICY:[52,3,1,""],USE_SPECIFIED_POLICY:[52,3,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy":{Type:[52,1,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type":{USE_SOURCE_POLICY:[52,3,1,""],USE_SPECIFIED_POLICY:[52,3,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo":{MacAddressType:[52,1,1,""],NetworkBackingType:[52,1,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType":{ASSIGNED:[52,3,1,""],GENERATED:[52,3,1,""],MANUAL:[52,3,1,""]},"com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType":{DISTRIBUTED_PORTGROUP:[52,3,1,""],HOST_DEVICE:[52,3,1,""],OPAQUE_NETWORK:[52,3,1,""],STANDARD_PORTGROUP:[52,3,1,""]},"com.vmware.vcenter_client":{Cluster:[1,1,1,""],Datacenter:[1,1,1,""],Datastore:[1,1,1,""],Deployment:[1,1,1,""],Folder:[1,1,1,""],Host:[1,1,1,""],Network:[1,1,1,""],ResourcePool:[1,1,1,""],StubFactory:[1,1,1,""],System:[1,1,1,""],VM:[1,1,1,""]},"com.vmware.vcenter_client.Cluster":{FilterSpec:[1,1,1,""],Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vcenter_client.Datacenter":{"delete":[1,2,1,""],CreateSpec:[1,1,1,""],FilterSpec:[1,1,1,""],Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vcenter_client.Datastore":{FilterSpec:[1,1,1,""],Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],Type:[1,1,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vcenter_client.Datastore.Type":{CIFS:[1,3,1,""],NFS41:[1,3,1,""],NFS:[1,3,1,""],VFFS:[1,3,1,""],VMFS:[1,3,1,""],VSAN:[1,3,1,""],VVOL:[1,3,1,""]},"com.vmware.vcenter_client.Deployment":{Info:[1,1,1,""],Task:[1,1,1,""],get:[1,2,1,""],rollback:[1,2,1,""]},"com.vmware.vcenter_client.Folder":{FilterSpec:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],Type:[1,1,1,""],list:[1,2,1,""]},"com.vmware.vcenter_client.Folder.Type":{DATACENTER:[1,3,1,""],DATASTORE:[1,3,1,""],HOST:[1,3,1,""],NETWORK:[1,3,1,""],VIRTUAL_MACHINE:[1,3,1,""]},"com.vmware.vcenter_client.Host":{"delete":[1,2,1,""],ConnectionState:[1,1,1,""],CreateSpec:[1,1,1,""],FilterSpec:[1,1,1,""],PowerState:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],connect:[1,2,1,""],create:[1,2,1,""],disconnect:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vcenter_client.Host.ConnectionState":{CONNECTED:[1,3,1,""],DISCONNECTED:[1,3,1,""],NOT_RESPONDING:[1,3,1,""]},"com.vmware.vcenter_client.Host.CreateSpec":{ThumbprintVerification:[1,1,1,""]},"com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification":{NONE:[1,3,1,""],THUMBPRINT:[1,3,1,""]},"com.vmware.vcenter_client.Host.PowerState":{POWERED_OFF:[1,3,1,""],POWERED_ON:[1,3,1,""],STANDBY:[1,3,1,""]},"com.vmware.vcenter_client.Network":{FilterSpec:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],Type:[1,1,1,""],list:[1,2,1,""]},"com.vmware.vcenter_client.Network.Type":{DISTRIBUTED_PORTGROUP:[1,3,1,""],OPAQUE_NETWORK:[1,3,1,""],STANDARD_PORTGROUP:[1,3,1,""]},"com.vmware.vcenter_client.ResourcePool":{"delete":[1,2,1,""],CreateSpec:[1,1,1,""],FilterSpec:[1,1,1,""],Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],ResourceAllocationCreateSpec:[1,1,1,""],ResourceAllocationInfo:[1,1,1,""],ResourceAllocationUpdateSpec:[1,1,1,""],SharesInfo:[1,1,1,""],Summary:[1,1,1,""],UpdateSpec:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.vcenter_client.ResourcePool.SharesInfo":{Level:[1,1,1,""]},"com.vmware.vcenter_client.ResourcePool.SharesInfo.Level":{CUSTOM:[1,3,1,""],HIGH:[1,3,1,""],LOW:[1,3,1,""],NORMAL:[1,3,1,""]},"com.vmware.vcenter_client.System":{HelloResult:[1,1,1,""],HelloSpec:[1,1,1,""],hello:[1,2,1,""]},"com.vmware.vcenter_client.VM":{"delete":[1,2,1,""],ClonePlacementSpec:[1,1,1,""],CloneSpec:[1,1,1,""],ComputePlacementSpec:[1,1,1,""],CreateSpec:[1,1,1,""],DiskCloneSpec:[1,1,1,""],DiskRelocateSpec:[1,1,1,""],FilterSpec:[1,1,1,""],GuestCustomizationSpec:[1,1,1,""],Info:[1,1,1,""],InstantClonePlacementSpec:[1,1,1,""],InstantCloneSpec:[1,1,1,""],InventoryPlacementSpec:[1,1,1,""],PlacementSpec:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],RegisterPlacementSpec:[1,1,1,""],RegisterSpec:[1,1,1,""],RelocatePlacementSpec:[1,1,1,""],RelocateSpec:[1,1,1,""],StoragePlacementSpec:[1,1,1,""],StoragePolicySpec:[1,1,1,""],Summary:[1,1,1,""],clone:[1,2,1,""],clone_task:[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],instant_clone:[1,2,1,""],list:[1,2,1,""],register:[1,2,1,""],relocate:[1,2,1,""],relocate_task:[1,2,1,""],unregister:[1,2,1,""]},"com.vmware.vstats_client":{AcqSpecs:[1,1,1,""],CidMid:[1,1,1,""],CounterMetadata:[1,1,1,""],CounterSets:[1,1,1,""],Counters:[1,1,1,""],Data:[1,1,1,""],Metrics:[1,1,1,""],Providers:[1,1,1,""],QueryPredicate:[1,1,1,""],ResourceAddressSchemas:[1,1,1,""],ResourceAddresses:[1,1,1,""],ResourceTypes:[1,1,1,""],RsrcId:[1,1,1,""],StubFactory:[1,1,1,""],UserInfo:[1,1,1,""]},"com.vmware.vstats_client.AcqSpecs":{"delete":[1,2,1,""],CounterSpec:[1,1,1,""],CreateSpec:[1,1,1,""],FilterSpec:[1,1,1,""],Info:[1,1,1,""],ListResult:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],Status:[1,1,1,""],UpdateSpec:[1,1,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"com.vmware.vstats_client.AcqSpecs.Status":{DISABLED:[1,3,1,""],ENABLED:[1,3,1,""],EXPIRED:[1,3,1,""]},"com.vmware.vstats_client.CounterMetadata":{CounterEditionStatus:[1,1,1,""],FilterSpec:[1,1,1,""],Info:[1,1,1,""],MetricUnits:[1,1,1,""],SampleType:[1,1,1,""],UnitsFactor:[1,1,1,""],get:[1,2,1,""],get_default:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vstats_client.CounterMetadata.CounterEditionStatus":{CURRENT:[1,3,1,""],DEFAULT:[1,3,1,""],DEPRECATED:[1,3,1,""],EXPERIMENTAL:[1,3,1,""],REMOVED:[1,3,1,""]},"com.vmware.vstats_client.CounterMetadata.MetricUnits":{AMPERE:[1,3,1,""],BIT:[1,3,1,""],BITSPERSECOND:[1,3,1,""],BYTE:[1,3,1,""],BYTESPERSECOND:[1,3,1,""],CANDELA:[1,3,1,""],CELSIUS:[1,3,1,""],GRAM:[1,3,1,""],HERTZ:[1,3,1,""],JOULE:[1,3,1,""],KELVIN:[1,3,1,""],KILOGRAM:[1,3,1,""],METER:[1,3,1,""],METERSPERSECOND:[1,3,1,""],METERSPERSECONDSQUARED:[1,3,1,""],MOLE:[1,3,1,""],NUMBER:[1,3,1,""],PERCENT:[1,3,1,""],SECOND:[1,3,1,""],VOLT:[1,3,1,""],VOLTAMPERE:[1,3,1,""],WATT:[1,3,1,""]},"com.vmware.vstats_client.CounterMetadata.SampleType":{ABSOLUTE:[1,3,1,""],DELTA:[1,3,1,""],FRACTION:[1,3,1,""],LOGN:[1,3,1,""],RATE:[1,3,1,""],RAW:[1,3,1,""]},"com.vmware.vstats_client.CounterMetadata.UnitsFactor":{ATTO:[1,3,1,""],CENTI:[1,3,1,""],DECA:[1,3,1,""],DECI:[1,3,1,""],EXA:[1,3,1,""],EXBI:[1,3,1,""],FEMTO:[1,3,1,""],GIBI:[1,3,1,""],GIGA:[1,3,1,""],HECTO:[1,3,1,""],KIBI:[1,3,1,""],KILO:[1,3,1,""],MEBI:[1,3,1,""],MEGA:[1,3,1,""],MICRO:[1,3,1,""],MILLI:[1,3,1,""],NANO:[1,3,1,""],ONE:[1,3,1,""],PEBI:[1,3,1,""],PETA:[1,3,1,""],PIKO:[1,3,1,""],TEBI:[1,3,1,""],TERA:[1,3,1,""],YOBI:[1,3,1,""],YOCTO:[1,3,1,""],YOTTA:[1,3,1,""],ZEBI:[1,3,1,""],ZEPTO:[1,3,1,""],ZETTA:[1,3,1,""]},"com.vmware.vstats_client.CounterSets":{Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vstats_client.Counters":{FilterSpec:[1,1,1,""],Info:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vstats_client.Data":{DataPoint:[1,1,1,""],DataPointsResult:[1,1,1,""],FilterSpec:[1,1,1,""],query_data_points:[1,2,1,""]},"com.vmware.vstats_client.Metrics":{RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],list:[1,2,1,""]},"com.vmware.vstats_client.Providers":{RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],list:[1,2,1,""]},"com.vmware.vstats_client.QueryPredicate":{ALL:[1,3,1,""],EQUAL:[1,3,1,""]},"com.vmware.vstats_client.ResourceAddressSchemas":{Info:[1,1,1,""],QueryCapabilities:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],ResourceIdDefinition:[1,1,1,""],get:[1,2,1,""]},"com.vmware.vstats_client.ResourceAddressSchemas.QueryCapabilities":{EQUAL:[1,3,1,""],EQUAL_ALL:[1,3,1,""]},"com.vmware.vstats_client.ResourceAddresses":{FilterSpec:[1,1,1,""],Info:[1,1,1,""],ListResult:[1,1,1,""],RESOURCE_TYPE:[1,3,1,""],get:[1,2,1,""],list:[1,2,1,""]},"com.vmware.vstats_client.ResourceTypes":{RESOURCE_TYPE:[1,3,1,""],Summary:[1,1,1,""],list:[1,2,1,""]},com:{vmware:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","exception","Python exception"],"5":["py","property","Python property"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:exception","5":"py:property"},terms:{"0":[1,2,3,4,6,11,15,16,17,18,20,22,23,24,25,26,27,28,31,33,34,35,36,38,39,40,41,42,43,44,45,46,51,52,53,54,61,62,63,64,65,66,67,68,71,74,76,77,78,79,80,81,82,87,88,89,90,91,92,93,94,95,97,98,99],"00":[1,2,11,89],"00100":52,"00200":[64,65],"01":[46,89],"03":46,"03t19":46,"0644":98,"07":2,"0c":[2,11],"1":[1,2,3,4,6,11,12,13,15,16,20,22,23,24,25,26,27,28,31,33,34,35,36,39,40,41,42,43,44,51,52,54,61,62,63,64,65,71,74,77,78,79,80,81,82,87,88,89,92,95,96,97,98,99,101],"10":[1,3,11,12,46,52,89,98],"100":[1,2,16,52,78],"1000":[1,11,12,52,78,83,84],"10000":[5,97],"1003746":52,"100gb":20,"101":[97,98],"1024":[1,52],"1034":97,"1068":99,"11":[52,89],"112":3,"11e9":51,"12":[1,46,52,89],"120":13,"1234":[1,52,66,98],"12345678":[1,52,66],"123456789abc":[1,52,66],"127":2,"128":[1,5,52,66,97,98],"13":[52,89],"14":52,"15":[1,52],"16":[1,52,97,98],"168":77,"169":98,"17":52,"18":[1,2,46,52],"180":13,"1878":46,"19":[52,54],"191":[3,11],"192":[77,97,98],"1mb":97,"2":[1,2,4,5,15,16,18,20,23,24,27,28,31,33,34,39,40,45,51,52,54,64,66,67,76,77,80,89,91,97,98,102],"20":[1,2,3,4,11,12,46,52,78],"200":52,"2000":[1,11,12,15,52],"2001":[97,98],"2003":52,"2008":52,"2012":[46,52],"2014":2,"2016":[1,89],"2018":[39,40],"20180128":[20,39,40],"2019":[24,27,33,34,35,36,41,42,46,52,89],"2020":24,"2021":[24,52],"2022":[52,75],"2023":[24,27,33,34,35,36,41,42,52,75],"2025":52,"2048":89,"204800":64,"20c":[3,11],"21":[1,45,52],"2145518":52,"23":[1,23,52,54,89],"230":[97,98],"2314":[1,15,16,64],"2373":[97,98],"24":[1,2,3,4,11,46,52,77],"2500":1,"254":[77,98],"256":[16,52,77,89],"26t12":46,"27da1358":51,"28":[46,52,81],"288":1,"29":[2,11,54],"29ff":[3,11],"2ba4":51,"2x":52,"3":[1,13,15,16,17,18,23,24,38,39,40,46,52,54,77,89,97,102],"30":[1,13,24,46,89,97],"3041":98,"3072":54,"31":[1,2,23],"3100":20,"32":[2,52,98],"336":1,"355667":[39,40],"360":1,"3600":74,"365":1,"384":89,"3987":47,"3d":18,"3rd":[23,39,40,52],"4":[1,15,51,52,89],"40":1,"4000":1,"401":52,"404":52,"4096":97,"41":1,"4100":20,"4133564":[39,40],"4293":[3,11,98],"436234":[39,40],"43cd":[1,15,16,64],"44":46,"443":[1,15,20,23,52,70,77],"4443":[52,81],"451z":46,"4862":98,"4x":52,"5":[1,2,11,12,13,14,15,20,47,52,54,84,89,97],"50":[1,98],"500":[1,11,12],"509":98,"5100":20,"512":[16,89],"524288":52,"5400":2,"59":[2,23,46,89],"5a":[2,11],"5b":45,"6":[1,2,3,4,5,6,14,15,16,17,24,47,51,52,54,68,69,70,83,84,96,97,100,101],"60":1,"6100":20,"63":[52,65],"63445":[39,40],"64":[1,3,11,47,52],"65536":52,"6749":[1,52],"6750":74,"6ede0f429751":[1,15,16,64],"6eff":[97,98],"6x":52,"7":[1,2,3,4,5,6,14,15,16,17,20,23,24,27,28,31,33,34,38,39,40,46,51,52,54,65,66,67,68,69,70,77,83,84,87,89,90,91,92,93,94,95,96,97,98,99,100],"70":1,"730":54,"7e":45,"8":[1,2,3,4,5,11,16,17,20,22,23,24,25,26,27,28,31,33,34,35,36,41,42,43,44,47,52,53,54,61,62,63,64,65,71,74,76,77,78,79,80,81,82,88,89,92,97],"80":[1,3,11,15,16],"8080":[52,81],"83":[3,11],"86400":[2,11],"8693":1,"87648":52,"9":[1,2,4,11,16,52,54,65,89,101],"9087":[23,24,41],"9123":52,"94":[2,11],"941z":46,"95":52,"973627":52,"98":52,"998":23,"99999":2,"abstract":[16,52],"boolean":[1,2,24,47],"break":[2,52,75,98],"byte":[1,12,15,16,17,28,47,52,71,97,98],"case":[1,3,11,12,13,14,15,16,17,20,21,23,24,28,47,51,52,54,63,64,65,75,77,80,90,95,97,99],"catch":[51,52],"class":[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],"default":[0,1,2,3,4,5,11,12,13,15,16,17,20,23,24,26,27,42,46,47,52,54,64,77,78,80,81,90,97,98,99,101,103],"do":[1,2,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,51,52,53,54,55,62,63,66,67,71,74,87,88,89,95,97,98,101],"enum":[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102],"export":[2,23,24,26,52,66,75],"final":[20,26],"float":[1,2,46,47,52],"function":[1,2,15,20,47,52,54,61,75,77,90,91],"import":[1,2,16,17,23,24,26,37,38,41,52,66,75,92,97,102],"int":46,"long":[1,2,3,4,5,11,12,13,14,15,16,17,18,20,23,24,27,28,31,33,34,35,36,41,42,46,47,52,54,64,65,70,71,74,75,76,77,78,80,81,88,89,90,97,98,99],"new":[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,29,31,33,34,35,36,37,41,42,43,44,45,46,47,51,52,54,55,57,59,60,64,65,66,67,71,72,75,76,77,78,80,81,83,84,87,89,90,91,92,93,94,95,96,97,98,99,100,101,102],"null":[24,54],"public":[1,15,17,51,52,54,65,75,89,91,93,96],"return":[1,2,3,4,5,6,8,11,12,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,48,49,50,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],"short":[1,2,16,20,23,46,52,66,97],"static":[1,3,11,24,52,81,96,97],"switch":[51,52,78,79,81,97],"throw":[1,20,23,26,52],"transient":51,"true":[1,2,11,12,13,14,15,17,18,23,24,28,41,47,52,63,75,77,78,80,96,97,98,100],"try":[8,17,23,24,28,41,43,51,52,97],"void":47,"while":[1,3,8,11,13,15,16,23,24,28,41,43,52,64,65,72,75,77,78,79,80,82,83,84,87,95,97,98,99,100,101],A:[1,2,4,11,12,13,14,15,16,17,18,20,21,23,24,25,38,45,46,47,49,51,52,53,54,55,64,65,66,71,75,77,78,80,81,84,87,88,89,90,91,92,95,96,97,98],AND:52,As:[1,23,52,77,98,101],At:[1,2,4,11,13,52,101],But:[23,47],By:52,For:[1,2,3,11,12,13,14,15,16,17,20,23,24,41,46,47,51,52,74,77,80,90,91,93,97,98,101],IS:14,If:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,51,52,54,55,59,62,63,64,66,67,70,71,72,75,76,77,78,79,80,81,82,83,84,87,89,90,91,92,93,94,95,96,97,98,99,100,101,102],In:[1,2,3,4,11,12,13,14,15,16,17,20,23,24,28,29,44,46,47,51,52,54,57,61,63,64,65,77,90,95,97,98,99,101,102],Is:[1,2,3,4,11,18,52],It:[1,2,3,4,11,12,13,15,16,17,18,19,23,24,26,29,41,44,46,47,51,52,54,63,71,75,77,78,81,89,90,97,98],Its:20,NOT:[23,45,52,54,74],No:[2,17,28,52,64,66,67,81,87,90,91,92,97],Not:[4,52,87,90,91,92],ONE:[1,11],OR:17,On:[2,16,52,76,97],One:[1,47,49,51,52,80],Such:46,That:24,The:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],There:[1,8,11,12,16,17,20,21,28,47,52,63,66,67,98,99,100],These:[1,8,11,15,16,20,23,28,43,46,47,52,57,59,77,78,81,93,97,98],To:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,93,95,96,97,98,99,100,101,102],Will:[2,54],With:[13,91],_:52,a871:[1,15,16,64],abandon:24,abc:72,abcd:[1,52,66],abil:[2,47,52,75,77,97],abl:[1,11,16,20,23,52,77,78,80,87,91,95],abort:[16,52,98],abort_retry_ignor:52,about:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,55,57,59,60,63,64,65,66,68,69,74,75,77,78,79,80,82,83,84,87,90,95,96,97,98,99,100,101],abov:[3,11,13,14,17,26,46,47,54],absent:[20,24],absolut:[1,11,12,13,46,97,98],accept:[1,3,11,16,23,47,51,52,71,77,87,95,97],accept_all_eula:52,accept_eula:[23,77],access:[1,2,8,11,12,13,15,16,17,24,46,51,52,54,57,59,64,65,74,77,78,81,82,93,97,98,99,101],access_cli:[0,1,103],access_list:52,access_set:11,access_token:[1,52,74],access_token_typ:[1,52],access_url:65,accessset:11,accesstoken:46,accident:1,accompani:[2,8,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,52,75,77],accord:[28,52,54,80],account:[1,2,11,21,52,97],acct:52,acm:[46,54],acq_spec:1,acqspec:1,acquir:[46,51,52,97],acquisit:1,acronym:47,across:[1,2,11,20,23,47,51,52,77,78,87],act:[1,8,16,41,52],action:[1,13,20,23,24,27,33,34,35,36,41,42,51,52,64,66,77,90,91,92,97],activ:[1,11,13,15,16,17,24,28,31,41,52,54,68,77,78,88,90,96,97],activate_with_templ:52,activatetemplatespec:52,activatewithtempl:52,active_cert_chain:54,active_directori:52,active_directory_domain:52,active_directory_over_ldap:52,active_loc:52,activedirectori:68,activedirectoryoverldap:52,activedirectoryspec:[52,68],activespec:52,actor_token:52,actor_token_typ:52,actual:[1,2,15,16,20,28,31,46,47,52,55,97],actuallli:66,ad:[1,2,3,4,5,6,8,11,14,15,16,17,20,22,23,24,25,26,27,28,29,31,33,34,35,36,38,40,41,42,43,44,46,47,51,52,53,54,61,62,63,66,67,68,69,70,71,72,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],ad_over_iwa:11,ad_over_ldap:11,adapt:[1,15,16,51,52,97,98,99],adapter_cli:[0,1,52,97,103],adaptermap:52,add:[1,3,14,17,20,23,24,26,29,37,41,44,47,51,52,63,66,71,72,75,90,91,93,97,99],add_on:[20,23,24,29,37,41,44],add_ons_cli:[0,1,20,23,103],add_to_used_bi:14,addcerttotruststor:1,addit:[1,3,8,13,15,20,23,24,26,28,31,43,45,46,47,51,52,61,63,71,77,80,97,98],addition:[24,52],additional_authorize_paramet:80,additional_delai:13,additional_opt:13,additional_param:52,additional_paramet:52,additional_properti:24,additional_scop:80,additionalopt:13,addlibraryitem:[15,52],addnewdisk:52,addon:[20,23,24,29,41,44],addoncompli:20,addondetail:20,addoninfo:[20,24,29,41,44],addonspec:[20,29,44],addonsummari:23,addonvers:23,addonversionsummari:23,addremovedevic:52,address:[1,2,3,11,18,20,23,46,51,52,54,61,68,70,77,78,81,82,87,90,95,96,97,98,99],address_count:52,address_rang:52,addresscount:52,addressinfo:3,addresss:52,addresult:71,addspec:[17,71],addsubscript:15,addtion:52,adf:11,adher:[2,4,11,51],adj_identical_char:11,adjac:11,adjust:77,admin:[2,4,52,74,77],admin_group:52,admincli:74,administ:[52,54],administr:[1,2,4,11,15,52,64,72,82,91],admiss:[13,24,27,33,34],admission_control:13,admissioncontrol:13,admit:13,adopt:77,advanc:[13,15,52,78],advanced_opt:13,advancedconfig:52,advertis:[39,40],affect:[1,13,15,23,24,27,28,32,34,35,36,41,42,52,77,87,95,101],affected_addon:23,affected_base_imag:23,affected_baselin:23,affected_desired_st:23,affected_hardware_support:23,affected_independent_compon:23,affected_solut:23,affected_upd:23,affectedbaselineinfo:23,affecteddesiredstateinfo:23,affin:[13,52,57,60],affine_host_group_nam:13,affinit:52,affinityrul:13,after:[1,2,4,5,13,15,16,17,20,23,24,27,28,33,34,35,36,41,42,46,47,51,52,54,66,68,75,96,97,98,100,101],after_clean_shutdown:52,again:[1,23,52],against:[1,8,11,15,17,20,21,23,24,26,28,41,52,57,59,75,84,87,91,94,95],agent:[1,13,20],aggreg:[1,8,20,23,28,43,47,87,95],aggregr:8,aggress:13,agil:89,agreement:[1,23,52,77],ahci:99,ahr0chm6ly8mizqyoy9ndwvzdezpbgu:98,alarm:[1,52,77],alg:46,algorithm:[1,16,46,52,54,89],alia:[1,11,20,87,97],aliv:16,all:[1,2,3,4,5,8,11,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,49,51,52,53,54,55,57,59,61,62,63,64,65,66,67,71,72,74,75,77,78,79,82,83,87,88,89,90,91,92,93,95,96,97,98,100,101],all_feasible_d:13,all_feasible_ds_with_user_prefer:13,all_with_def:52,alloc:[1,11,12,51,52,76,77,81],allocat:77,allocateresourc:76,allocatespac:[1,52],allow:[1,2,3,4,11,13,15,16,17,20,23,24,26,29,44,46,51,52,57,61,65,66,75,77,80,91,94,96,97,98,102],allow_guest_control:97,allowed_valu:2,allowedvalu:2,almalinux:52,almalinux_64:52,alon:[12,52],along:[1,2,3,16,24,41,47,51,52,74,101],alpha_char:11,alphabet:11,alphanumer:[52,65],alreadi:[1,2,4,8,14,15,16,17,20,23,24,26,29,41,44,51,52,54,61,63,64,65,66,75,77,80,87,90,92,93,95,97,98,101],already_exist:51,already_in_desired_st:51,alreadyexist:[1,2,4,8,14,15,23,24,41,51,52,54,64,65,66,75,77,87,90,91,92,95,98,101],alreadyindesiredst:[1,2,23,51,52,97],also:[1,2,13,14,15,16,20,21,23,24,26,28,31,41,46,47,49,51,52,55,61,63,77,91,97,98],alter:1,altern:[54,77],although:[3,11,51,52],alto:[17,52,54],alwai:[1,2,3,15,16,17,47,52,77,80,91],am:[23,51,80],amazon:52,amazonlinux2_64:52,amazonlinux3_64:52,ambigu:[1,28],amd:97,among:[40,52,99],amongst:52,amount:[1,11,12,14,16,18,51,52,64,71,76,77,97,98],amper:1,an:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,54,55,57,59,60,61,62,63,64,65,66,67,69,71,72,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],analysi:[13,24],ani:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,23,24,26,28,29,30,31,39,40,41,44,46,47,48,49,50,51,52,55,61,62,63,64,65,66,71,74,75,77,80,81,83,84,87,88,90,91,93,94,95,96,97,98,99,100,101],annot:[47,52],announc:54,anonym:[16,17,52],anoth:[1,2,8,12,15,16,23,24,26,41,45,47,51,52,63,77,78,97,99,101],answer:[2,52],answer_v:52,answerspec:52,anti:[13,57,60],anti_affine_host_group_nam:13,anti_affinity_with_vcl:60,anti_affinity_with_vcls_cli:[52,55,56,57,58],antiaffinityrul:13,any_error:47,anymor:1,anywher:[47,52,65],apart:[52,77,87,95],apd:[13,51],apd_failure_respons:13,api:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,31,33,34,35,36,37,38,41,42,43,44,45,46,47,51,52,53,54,55,57,59,61,62,63,64,65,66,67,68,69,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],api_releas:1,api_serv:52,api_server_cluster_endpoint:52,api_server_management_endpoint:52,apiserv:52,aplic:2,app:52,appear:[1,3,11,20,52,99],append:52,appl:97,appli:[1,2,3,8,11,12,13,15,16,17,20,23,24,25,26,27,28,31,33,34,35,36,41,42,43,47,52,55,59,65,66,75,77,78,80,81,82,83,84,87,95,97,98,100,101],applianc:[0,1,15,20,23,24,41,52,54,68,69,86,103],appliance_cli:[0,2,103],appliancelocalaccount:2,appliancemanag:[8,11],appliancenetwork:11,appliances:52,appliancest:[1,52],appliancetyp:52,applic:[1,2,8,11,13,15,16,17,23,24,27,28,31,33,34,36,41,42,43,47,51,52,57,59,61,74,75,77,83,84,97,98,100],applmgmt:[1,2],applmgmt_client:[2,7,8,9,10],apply_cli:[0,1,20,23,24,32,33,35,41],apply_desired_state_task:8,apply_impact:8,apply_policy_spec:[23,24],apply_spec:8,apply_statu:[24,41],apply_task:[23,24],apply_task_id:26,applydesiredstatespec:8,applyimpact:[8,28,43],applyimpactspec:28,applyresult:[8,23,24,25,28,43],applyspec:[8,23,24],applystatu:[8,23,28,43],applystatustyp:[24,41],approach:77,appropri:[46,52,97],approv:[13,93],approximate_download_s:52,approximate_flat_deployment_s:52,approximate_sparse_deployment_s:52,appserv:14,ar:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],arbitrari:[2,46,47],architectur:89,archiv:[4,5,97],area:[2,52,89],aren:[16,17],arg:[1,2,4,46],argment:97,argument:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],argumentloc:[51,52],around:[15,52],arrai:[24,97],arriv:52,articl:[2,23,37,52],asap:2,ascend:52,ascii:[1,2,4,11,45],asianux:52,asianux_3:52,asianux_3_64:52,asianux_4:52,asianux_4_64:52,asianux_5_64:52,asianux_7_64:52,asianux_8_64:52,asianux_9_64:52,ask:97,aspect:[1,52],aspx:52,assert:52,assign:[1,3,11,14,20,47,50,52,65,77,78,96,97,98],assigne:77,assignvmtopool:1,assist:[2,45,52,75,77],associ:[1,2,4,5,8,11,12,14,15,16,17,18,20,22,23,24,25,26,27,28,29,30,31,41,42,43,44,46,47,48,49,50,52,54,57,59,60,62,63,64,74,75,77,80,81,82,83,84,89,90,97,98,100,101],associable_typ:14,associatedproduct:75,assos:20,assosi:75,assum:[2,13,52,95,96],assumpt:52,asterisk:98,asynchron:[1,15,52],atapi:97,atleast:84,atom:1,attach:[14,51,52,97,100],attach_multiple_tags_to_object:14,attach_tag_to_multiple_object:14,attack:[2,75],attempt:[1,2,11,13,15,20,24,27,33,34,51,52,66,81,93,97,99,101],attent:[52,66,67,87,90,91,92,96],attest:[0,1,52,61,87,88,90,95],attestation_cli:[0,1,52,103],attibut:[52,98],atto:1,attr:[52,54],attribut:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],attribute_illeg:52,attribute_requir:52,attrit:102,audienc:52,audit:[24,71],auditrecord:24,auth_endpoint:52,auth_query_param:52,auth_typ:[20,23],authcommon_cli:[2,7,8,9,10],authendpoint:52,authent:[0,1,2,4,8,11,14,15,16,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,51,52,53,61,62,63,64,65,66,67,68,69,70,71,73,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,97,98,99,100,101,103],authentication_cli:[0,1,46,48,103],authentication_head:52,authentication_method:[15,52],authenticationinfo:47,authenticationmanag:[8,11],authenticationmethod:15,authenticationschem:46,authenticationtyp:[20,23],authentinc:96,authmanagement_cli:[2,7,8,9,10],authmgmt:8,author:[0,1,2,8,11,15,16,23,24,26,41,45,46,47,51,52,54,66,67,72,74,77,80,82,87,88,89,91,92,93,95,101,103],authority_information_access_uri:54,authorization_cli:[0,1,103],authtyp:[20,23],authz:52,auto:[2,3,11,18,52,75,96],auto_answ:52,auto_connect:18,auto_detect:97,auto_failover_allow:52,auto_logon:52,auto_logon_count:52,auto_stag:[2,11],auto_upd:2,auto_update_support:52,autoconf:[3,11,98],autoconfigur:[3,11,98],autodetect:97,autogener:52,autom:[1,8,11,13,57,59],automat:[1,2,3,11,13,15,16,18,23,52,65,66,75,77,78,81,96,97,98,101],automatic_sync_en:[1,15],automatic_sync_start_hour:1,automatic_sync_stop_hour:1,automation_level:[11,13],automationlevel:13,autorun:97,autoupdatenotif:11,auxillari:20,avail:[1,2,3,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,52,55,57,59,66,67,71,75,76,77,78,81,87,88,89,90,91,92,95,96,97,98,99,101],availab:52,available_vers:77,avali:2,avamar:[17,52],averag:1,avg:1,avi:[52,78],avi_config_create_spec:52,avi_config_set_spec:52,avi_config_update_spec:52,avi_info:52,aviconfigcreatespec:52,aviconfigsetspec:52,aviconfigupdatespec:52,aviinfo:52,avoid:[51,52],aw:[11,52,56,57,59,72,93],awai:57,awar:[47,75],awq9msz0b2tlbj0xmjm0:98,axi:1,b210:51,b8a2a2e3:[1,15,16,64],b:[14,52],back:[1,2,4,11,15,16,17,52,64,66,77,81,97,98,101,102],backend:83,background:[2,11],backin:2,backing_typ:52,backinginfo:97,backingspec:[1,97],backingtyp:97,backup:[0,1,2,4,11,15,17,52,101,103],backup_cli:[0,1,2,5,103],backup_password:[2,4,11],backup_schedul:11,backupjob:4,backupjobstatu:4,backuppassword:[2,4,11],backuprequest:[2,4],backuprestoreprocessst:4,backupschedul:11,backward:[1,8,11,52,57,59],balanc:[52,77,78,81],bandwidth:[1,23],bank:[88,89],banner:77,base64:[1,16,17,52,54,64,66,77],base64encod:52,base64url:1,base:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],base_imag:[20,23,24,29,37,41,44],base_image_explanation_detail:[24,41],base_image_vers:[24,28,39,40],base_images_cli:[0,1,20,23,103],baseimag:[23,24,29,41,44,92],baseimagecompli:20,baseimagedetail:20,baseimageinfo:[20,24,29,41,44],baseimagespec:[20,28,29,44],baseimagevers:[23,39,40],baselin:23,bash:[2,11,97],basi:[1,52,64],basic:[15,18,47,51,52,64,65,75,77,78,79,87,95,97],basicconstraint:54,batch:[14,29,44,52,77,97],batchresult:14,bb5a:[3,11],bb:[2,11],bearer:[1,11,46,47,52,74,97],bearer_refresh:11,bearer_token:47,bearer_token_method_typ:[1,52,74],beat:13,becaus:[1,2,3,5,8,11,13,14,15,20,22,23,24,27,28,34,51,52,63,83,84,97,98,99,100,101],becom:[1,13,14,15,16,17,52,81,83,84,98,100,101],been:[1,2,5,12,13,14,15,16,17,20,23,24,27,28,33,34,35,36,41,42,43,47,51,52,54,57,63,65,77,87,91,92,93,95,97,98,99,101],befor:[1,2,4,5,11,13,14,15,16,20,23,24,26,27,28,33,34,35,36,41,42,43,47,51,52,71,77,97],begin:[1,13,52,77,97],begin_certif:1,behalf:52,behavior:[1,5,11,13,15,16,17,23,39,40,52,55,62,63,66,67,77,78,79,82,88,89,91,93,97,98,100],behaviortyp:13,behaviour:13,behind:[1,52,98],being:[1,2,3,11,15,16,17,20,23,24,26,28,29,41,43,46,47,51,52,54,64,65,77,80,87,89,95,97,98,99,101],believ:[2,75],belong:[1,11,13,14,15,16,18,22,23,47,52,74,77,87,95,97,99,101],below:[28,52,71,98],best:[1,52],better:23,between:[1,2,8,11,12,24,52,62,63,65,75,77,87,96,98,99],beyond:[1,11,12,52,56,57,59,72,77,78],bin:[52,97],binari:47,bind:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],bio:[20,21,23,24,28,52,97,99],bios_constraint:21,bios_uuid:[1,52],biosconstraint:21,biosuuid:52,bit:[1,3,11,47,52,54,66,89,97,98],bitspersecond:1,blacklist:52,blank:[1,52],block:[1,2,5,8,14,18,20,52],board:20,bodi:52,bool:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,20,23,24,26,27,28,33,34,35,36,41,42,46,47,51,52,54,63,66,75,77,78,79,80,83,88,89,90,91,93,96,97,98,100,101],boolean_valu:47,boot:[1,13,24,27,33,34,35,36,41,42,97,99],boot_client:[0,1,52,97,103],boot_devic:1,boot_imgdb:92,bootabl:99,bootstrap:74,both:[1,11,13,15,17,20,24,52,75,77,78,101,102],bottom:3,bound:[1,11,12,51,52,89,97,99],boundari:47,box:[2,52],boxnam:2,brain:52,breach:2,bridg:51,brief:[52,77,87],bring:[52,77],broadcast:[52,77],broadcom:20,broker:[0,1,11,52,73,103],broker_cli:[0,1,52,103],bronz:20,browser:[11,54],bu:[1,52,97,99],bubbl:[39,40],buffer:[71,97],bug:[2,52,75],bugfix:[23,37],build:[2,5,18,39,40,46,75],build_numb:5,buildinfo:5,built:47,builtin:47,builtin_typ:47,builtintyp:47,bulletin:23,bundl:[1,2,4,23,38,39,40,52,75,81],bundle_typ:23,buse:99,busi:[1,3,51,52,97,98,99,101],buslog:99,button:51,bypass:2,bytes_transf:17,bytespersecond:1,c:[14,17,35,36,41,42,51,52,97],ca:[1,52,54,78,81,91,95],cacertif:91,cach:[1,15,16,23,47,100],calcul:[1,14,16,17,47,52,89],california:[17,52,54],call:[1,2,8,11,12,14,15,16,20,21,23,24,28,41,47,52,61,65,71,74,75,77,82,94,98],caller:[1,2,8,17,20,21,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44,52,54,66,67,68,69,70,71,87,88,89,90,91,92,93,94,95,98],camelcas:[52,77],can:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,33,34,41,43,45,46,47,49,51,52,53,54,55,57,59,60,61,62,63,64,65,66,68,69,71,74,75,76,77,78,79,80,81,82,83,84,87,89,91,92,93,95,97,98,99,100,101,102],cancel:[1,2,4,5,8,14,16,20,24,26,51,52],candela:1,candid:13,cannot:[1,2,3,4,6,11,13,14,15,16,20,21,23,24,28,31,51,52,59,65,75,77,78,79,80,83,88,89,93,96,97,98,99,100,101],canon:47,canonical_nam:47,canonicalnam:47,capabilities_cli:[0,1,52,55,103],capabl:[0,1,52,55,56,61,66,77,100],capac:[1,12,13,15,18,28,31,52,64,71,77,97],capas:2,capit:47,captur:[24,52,97],card:[18,20],cardin:14,carri:71,carvel:[52,77],carvel_apps_check_result:52,carvel_apps_yaml:77,carvel_spec:[52,77],carvelappscheckresult:52,carvelcreatespec:[52,77],cass:100,catalog:[15,46,75],categor:[13,31],categori:[1,2,8,14,23,24,37,47,51,52,55,75,98],category_id:14,category_nam:55,categorymodel:14,categorytyp:[23,37],caught:91,caus:[1,15,24,51,52,77,97,100],caution:[2,6],cc771830:52,cd:[1,18,52,97,99],cdef:[1,52,66],cdrom:[1,2,52,97,99],ceip:[11,20,21,52],ceip_en:52,celsiu:1,center:97,centi:1,cento:52,centos_64:52,centos_6:52,centos_6_64:52,centos_7:52,centos_7_64:52,centos_8_64:52,centos_9_64:52,cert:[54,91],cert_chain:[16,17,52,54,64,91],cert_text:1,certain:[1,2,11,12,16,51,75,77],certif:[1,2,11,15,16,17,20,23,28,31,51,52,54,61,64,77,78,80,81,87,89,91,93,94,95,96,97,98],certifi:[20,28,31,61],certificate_authority_chain:[52,78],certificate_authority_data:80,certificate_check:2,certificate_dns_nam:77,certificate_error:1,certificate_info:17,certificate_manag:[0,1,52,103],certificate_management_cli:[0,1,54,103],certificate_verification_info:15,certificateauthor:64,certificateauthoritychain:52,certificateauthoritydata:80,certificatecheck:2,certificateinfo:[17,20,52,96],certificatemanag:54,certificateparam:52,certificatesigningrequest:52,certificateverificationinfo:[15,16],certtext:1,certverificationstatu:16,cetain:1,cfg_list:2,cfglist:2,chain:[15,16,17,52,54,64,78,87,89,91,95],challeng:51,chanc:13,chang:[1,2,4,5,6,8,11,13,14,15,16,17,18,20,23,24,27,28,31,33,34,35,36,41,42,46,47,51,52,57,59,75,77,78,80,91,96,97,98,99,101],change_lag:52,change_task:1,changedetail:24,changedproperti:24,changespec:1,changesresult:24,channel:16,charact:[1,2,4,11,15,16,45,47,52,65,97],characterist:[1,47],chat:11,check:[1,2,4,8,11,13,14,15,16,20,21,23,24,25,26,28,30,31,41,43,47,52,53,68,69,71,75,77,79,96,97,99,100,101],check_compat:52,check_compli:[23,24,25],check_compliance_task:[23,24],check_cont:52,check_desired_state_task:8,check_eligibility_task:26,check_in:101,check_issu:[23,43],check_out:[52,101],check_schedul:[2,11],check_spec:[8,100],check_status:[20,23,28,43],check_task:[23,24,28,41],check_tim:[2,24,41,100],checkbox:2,checkcompli:24,checkcompliancespec:24,checkdescript:20,checkdesiredstatespec:8,checkerror:20,checkinfo:[23,28,43,52,68,69],checkinspec:101,checkintempl:101,checkissu:[23,43],checkout:101,checkoutinfo:52,checkoutspec:101,checkouttempl:101,checkresult:[8,23,24,28,30,31,41,43,52,96],checks_to_skip:[24,41],checkspec:[8,23,24,41,68,96,100],checkstatu:[20,23,28,43,52],checksum:[13,16,17],checksum_en:13,checksum_info:[16,17],checksumalgorithm:16,checksuminfo:[16,17],checksummari:28,checktyp:[24,41],child:[1,11,12,47,52,89],child_resource_pool:12,children:[1,47,52],chipset:20,chmod:98,choic:[1,13,52,97],choos:[1,13,15,20,23,47,52,97,99,101],chosen:[1,13,15,23,24,29,41,44,52,90,97,98,99,101],chronolog:52,ci:[0,1,2,5,8,20,21,23,24,25,26,28,41,52,55,57,59,60,75,103],cid:1,cid_mid:1,cidmid:1,cidr:[3,11,52],cif:1,circumst:[1,52],cis_client:[0,103],citi:52,claim:[52,80],claim_map:52,class_cod:20,class_id:52,classic:52,classid:52,classif:[52,77],classs:52,cldr:46,clean:[16,52,77,97,98],clean_power_off:52,cleanli:52,cleanup:[15,28,52],clear:[13,24,52,97],cli:[2,11,46,47],cli_client:[0,1,46,103],click:51,client:[1,2,4,5,8,12,14,15,16,17,18,20,21,23,24,25,26,28,29,31,37,38,39,40,41,43,44,45,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,71,74,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],client_affin:52,client_certificate_cli:[1,52,87,90,93],client_devic:97,client_error_messag:16,client_id:[52,80],client_progress:16,client_secret:[52,80],client_secret_bas:52,client_secret_jwt:52,client_secret_post:52,client_token:[1,15,16,52,64],client_trust_serv:90,clientcap:8,clientcertif:93,clientid:[52,80],clientprofil:87,clobber:1,clock:[4,11],clock_toler:11,clone:[1,16,52,96],clone_task:1,cloneplacementspec:1,clonespec:1,close:[51,52],cloud:[11,52,56,57,59,72,77,80],cloud_config:52,cloud_gatewai:11,cloud_native_file_volum:[52,77],cloudadmingroup:72,cloudadminroleprotect:11,cloudconfigur:52,cloudinit:52,cloudinitconfigur:52,clsuter:28,cluster:[0,1,8,9,10,11,12,15,20,22,23,32,51,52,57,60,62,63,64,65,77,78,80,87,90,91,92,93,94,95,96,101,103],cluster_cli:[0,1,7,8,9,10,11,52,62,103],cluster_configur:[52,81],cluster_default:13,cluster_deploy_op:52,cluster_distributed_switch:52,cluster_failover_op:52,cluster_filt:52,cluster_get_op:52,cluster_id:[23,24],cluster_isolation_respons:13,cluster_nam:[23,52,77],cluster_proxy_config:52,cluster_resource_percentag:13,cluster_restart_prior:13,cluster_scale_in_ignore_vm_cap:57,cluster_scale_in_ignore_vm_capabilities_cli:[0,1,52,55,56],cluster_set:13,cluster_statu:24,cluster_summari:52,cluster_undeploy_op:52,clusteravailablevers:52,clustercompat:52,clustercompli:[20,24,25,26],clustercomputeresourc:[1,15,23,24,25,26,27,28,29,30,31,52,62,63,64,77,87,90,91,92,93,94,95,101],clusterconfiginfo:[11,12],clusterconfigur:[11,23,24,25,26],clusterimpact:28,clustermod:[52,96],clusterprecheckresult:[24,25],clusterresourcepercentag:13,clusters_cli:[0,1,20,24,25,28,52,103],clustersizeinfo:[52,77],clusterst:52,clustersummari:52,clustersupervisorservic:[64,77],cmd:97,cn:[17,52],cns_client:[0,1,52,103],cns_file_config:52,cnsfileconfig:[52,77],code:[2,8,23,24,26,28,43,45,52,80,97],coexist:24,coldmigr:1,collect:[1,2,18,19,24,47,52,54,64,65,95],collectprivilegecheck:[52,53],colon:[97,98],column_numb:52,com:[102,103],combin:[2,5,28,46,51,52,77],come:[2,15,52],comma:[3,11,52],command:[1,47,51,52,89,97],command_line_opt:52,comment:[2,4,5],comment_substr:5,commit:[1,8,13,20,23,24,28,41,43],commit_task:[24,41],commit_tim:[24,41],commitspec:[24,41],common:[1,2,12,14,15,45,51,52,54,55,76,77,78],common_cli:[0,1,7,8,9,10,11,13,52,75,103],common_nam:54,commoninfo:[1,2,5,8,14,20,52],commonli:[1,5,15,16,52,55,97,99,101],commun:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,93,95,96,97,98,99,100,102],compani:[23,52],compar:[13,15,20,23,24,28,47,52,75],comparison:28,compat:[1,8,11,15,20,21,23,24,27,28,31,33,34,39,40,51,52,57,59,75,77,78,79,97,98],compatibility_guide_link:28,compatibilitydata:20,compatibilityinfo:52,compatibilityreleas:21,compatibilityreport:[20,21],compatibilitystatu:[20,21],compatibl:[20,21],compatible_count:75,compatible_datastor:52,compatible_devic:28,compatible_network:52,compatible_releas:75,compatible_vers:28,compatibledatastoreinfo:52,compatiblil:52,complet:[1,2,4,5,8,11,12,14,15,16,17,20,23,24,25,26,28,43,47,51,52,54,63,75,77,83,84,92,97,98,99,100,101],complex:[24,77,89],complianc:[8,13,15,20,23,24,25,26,28,30,31,41,43,52,54,55,83,84,97,100],compliance_cli:[0,1,52,83,103],compliance_info:24,compliance_result:8,complianceact:31,complianceimpact:20,complianceinfo:24,complianceresult:8,compliancestatu:[8,20,24,28,31,83],compliancestatusdetail:28,compliant:[8,20,23,24,28,31,52,55,83,84,90,100],compliant_data_processing_unit:20,compliant_host:[20,24],compon:[1,2,7,8,9,10,14,20,22,23,24,28,29,37,40,41,44,46,47,52,77,87],component_class:20,component_id:47,componentbundletyp:23,componentcompli:20,componentdata:47,componentdetail:20,componentinfo:[20,24,29,37,40,41,44,47],componentoverrideinfo:20,components_cli:[0,1,2,7,8,9,20,23,103],components_to_delet:[29,44],components_to_set:[29,44],componentsourc:20,componentsummari:23,componentvers:23,componentversioninfo:37,componentversionsummari:23,compos:1,composit:[1,46],compress:52,compris:[1,29,44,52],compromis:[2,75],comput:[0,1,13,20,26,28,47,51,52,77,83,84,97,100,101,103],compute_cli:[0,1,55,57,59,60,103],compute_polici:97,computeplacementspec:1,computepolici:52,computer_nam:52,concaten:[52,80],concept:[1,52],concern:14,concret:16,concurr:[1,15,24],concurrent_chang:51,concurrentchang:[1,24,41,51],condit:[13,51,52,77],confidenti:[2,24,27,33,34,35,36,41,42,52,75],confidential_comput:[0,1,52,103],config:[1,2,3,4,5,6,7,8,9,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],config_cli:[0,1,2,7,8],config_in_progress:52,config_map_count:52,config_map_count_unset:52,config_spec:[2,52],config_st:52,config_statu:[52,65,77],config_tag:52,configcurr:8,configinfo:12,configmanag:[8,9,10,12,24,26],configmap:52,configmapcount:52,configmnag:26,configspec:52,configst:52,configstatu:[52,65,77],configtag:52,configtyp:52,configur:[0,1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,22,23,24,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,47,48,49,50,51,52,53,54,55,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],configuration_cli:[0,1,20,23,25,103],configuration_spec:52,configurationmodel:[1,15],configurationspec:[24,52],configuraton:51,configuredpolicyspec:[24,33,35,41],confirm:[97,99],conflict:[1,13,20,24,52],conflictdetail:24,conflictpropertyinfo:24,conform:[1,15,16,46],conifgur:99,conjunct:77,connect:[1,2,3,11,12,13,16,18,20,23,46,51,52,68,70,71,77,80,81,87,90,93,96,97,98,99],connection_cooki:97,connection_health_statu:52,connection_st:1,connection_timeout:90,connectioncreatespec:97,connectionhealthstatu:52,connectioninfo:97,connectionspec:[20,23,52],connectionst:[1,97],connectionstatu:2,connectionupdatespec:97,conserv:[13,46,77],consid:[15,17,20,21,23,28,52,57,77,78,87,93,95],consist:[1,11,12,20,52,75,87,91,92,95,97,98],consol:[2,11,97],console_cli:[0,1,11,52,103],consolecli:[2,11],consolid:24,constant:[1,46,47],constantinfo:47,constantvalu:47,constitut:52,constrain:[39,40,77,97],constraint:[1,11,12,20,21,24,28,29,41,44,52,54,66,97],constraintsspec:66,construct:[14,46,52,89],consult:1,consum:[1,8,11,12,16,45,51,52,77,78,97],consumerprincip:87,consumpt:[1,51,52,63],consumption_domain:[0,1,52,77,78,103],consumption_domains_cli:[0,1,103],contact:[1,15,37,51,93],contain:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],containt:47,contant:47,content:[0,1,2,11,12,13,20,23,24,38,41,47,52,77,97,98,101],content_cli:[0,15,18,103],content_librari:[52,77],content_typ:[52,77],content_vers:[15,16],contentcheckspec:52,contentlib:15,contentlibrari:[1,15,16,17,52,64,65,101],contentlibraryspec:[52,77],contenttyp:[52,77],conter:1,context:[1,20,23,46,47,51,52,98],contigu:[97,98],contin:52,continu:[1,23,52,98],contract:51,control:[1,2,11,13,18,24,27,28,33,34,41,52,77,78,81],control_plan:52,controlplan:[52,77],controlplanevmsconfigur:[52,77],controlplanevmsdeploi:[52,77],conveni:[2,46,47],convent:47,convers:[3,11,52],convert:[46,52],cooki:97,copi:[1,15,16,17,20,24,29,41,44,51,52,77,87,98,101],copyright:[24,27,33,34,35,36,41,42,52,75],core:[1,52,97],core_events_task:52,core_events_tasks_with_def:52,coreo:52,coreos_64:52,cores_per_socket:[52,97],corpor:[17,52,78],correct:[17,46,51],correctli:[16,17,52,65,77,97],correpsond:[3,11],correspond:[1,3,5,11,14,15,20,24,28,31,47,48,49,50,52,54,75,77,87,89,95,98],corrupt:[2,52],cost:47,could:[1,2,12,14,15,16,21,23,24,28,31,46,47,51,52,54,63,64,65,75,77,87,89,97,98,99],count:[1,5,11,23,52,75,77,97],counter:[1,77],counter_set:1,countereditionstatu:1,counterexampl:51,countermetadata:1,counterpart:52,counterset:1,counterspec:1,countri:54,cover:61,cpu:[1,11,12,13,18,20,21,28,51,52,61,76,77,97],cpu_alloc:[1,11,12],cpu_capac:[52,77],cpu_count:[1,52],cpu_featur:20,cpu_limit:52,cpu_limit_default:52,cpu_limit_default_unset:52,cpu_limit_unset:52,cpu_request_default:52,cpu_request_default_unset:52,cpu_reserv:52,cpu_seri:[20,21],cpu_upd:52,cpu_us:[52,77],cpuinfo:52,cpuupdatespec:52,crash:[1,52],creat:[1,2,3,4,5,6,8,11,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,48,49,50,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],create_from_host:23,create_from_host_task:23,create_new:15,create_par:98,create_resource_quota_typ:52,create_spec:[1,14,15,16,52],create_spec_typ:[52,55],create_task:[1,21,23,75,87,90,91,93,94,95],create_temporari:98,create_tim:23,create_v2:52,created_tim:1,createfromexist:1,createlocallibrari:1,createplacementspec:52,createpool:1,createresourcequotatyp:52,createresult:[23,52],createspec:[1,4,8,14,15,23,24,52,54,55,57,59,60,64,65,66,75,77,80,87,90,91,95,97,98,99,102],createspecdiskstorag:52,createspecdiskstoragepolici:52,createspecnewsubscribedlibrari:15,createspecplac:15,createspecsubscribedlibrari:15,createspecv2:52,createspecvcent:15,createspecvmhomestorag:52,createspecvmhomestoragepolici:52,createsubscribedlibrari:1,createtarget:52,creation:[1,8,15,16,21,23,24,41,52,54,64,65,75,77,91,97,98,99],creation_statu:1,creation_tim:[1,8,15,23,24,41,64,65],creationstatu:1,creationtim:65,creator:52,credenti:[1,20,23,45,47,51,52,68,69,77,93,96,97,98],credentialsspec:[52,96],criteria:[1,14,28,52,62,77,78,92,95],critic:[2,23,37,54,66,67,75],crud:47,crx:52,crxpod_1:52,crypto:89,crypto_manag:[0,1,52,103],crypto_manager_cli:[0,1,103],cryptograph:[52,61,66,67],csp:[11,52,80],csr:[54,93,94],csv:[47,52,75],csv_report:75,csvreport:75,ctrl:51,current:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,41,42,43,44,45,46,47,51,52,55,57,59,61,64,65,66,67,71,75,76,77,78,80,81,83,84,87,89,90,91,92,93,95,96,97,98,99,100,101,102],current_compatibility_releas:21,current_password:[1,15],current_series_recommend:[24,41],current_sourc:20,current_valu:[8,24],current_vers:77,currently_avail:71,currentlyavail:71,currentpeercertif:93,custom:[1,2,4,5,8,11,12,20,21,24,47,52,54,75,97],custom_label:52,custom_spec:[52,77],custom_url:2,custom_yaml:[52,77],customcreatespec:[52,77],customiz:52,customizatio:97,customization_spec:52,customizationspec:[52,97],cvd:52,cycl:52,d663bd873d93:51,d9ff:[97,98],d:[14,46],da:13,daemon:1,daemon_set_count:52,daemon_set_count_unset:52,daemonset:52,daemonsetcount:52,dai:[1,2,4,11,23,24,54,64],daili:[1,23,64],darwin:52,darwin_10:52,darwin_10_64:52,darwin_11:52,darwin_11_64:52,darwin_12_64:52,darwin_13_64:52,darwin_14_64:52,darwin_15_64:52,darwin_16_64:52,darwin_17_64:52,darwin_18_64:52,darwin_19_64:52,darwin_20_64:52,darwin_21_64:52,darwin_22_64:52,darwin_23_64:52,darwin_64:52,dash:52,dasinfo:13,data:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,49,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,73,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],data_item:2,data_migration_info:52,data_point:1,data_processing_unit:20,data_processing_unit_info:20,data_processing_units_compli:20,data_set:[52,97],data_sets_cli:[0,1,52,103],databas:[1,2,23,52,75],databaseserv:14,databasestorag:2,datacent:[1,11,12,52],datacenter_cli:[7,8,9,10,11],datacenter_nam:52,dataitem:2,datamigrationestim:52,datamigrationinfo:52,dataplan:52,datapoint:1,datapointsresult:1,dataprocessingunit:20,dataprocessingunitcompli:20,dataprocessingunitinfo:20,dataprocessingunitscompli:20,dataset:[52,97],datasetcr:52,datasetdelet:52,datasetentrydelet:97,datasetentryget:97,datasetentrylist:97,datasetentryset:97,datasetget:52,datasetlist:52,datasetupd:52,datasourc:52,datastor:[1,11,12,13,15,16,17,51,52,77,83,84,96,97,100],datastore_cli:[0,1,7,8,9,10,11,103],datastore_fold:1,datastore_id:[1,15,52],datastore_nam:52,datastore_path:1,datastore_with_pdl_failure_respons:13,datator:1,datatyp:13,datavalu:[2,8,14,20],date:[1,2,11,15,16,20,23,37,46,52,54,64,65,75,77,83,84,98,100,101],date_cr:75,date_tim:47,datetim:[1,2,4,5,8,14,15,16,20,21,23,24,26,28,37,41,43,46,47,52,54,64,65,66,75,77,92,97,98,100,101],datetime_config:11,datetimeconfig:11,datetimeformat:46,day1:1,day_of_month:23,day_of_week:[23,64],dayofweek:[2,4,11,23,64],days_after_password_expir:1,db8:[97,98],db:[2,4,5],db_health_check_state_manual_backup:1,db_health_check_state_scheduled_backup:1,dcui:[2,11],ddthh:46,deactiv:[52,77],deal:[77,97,98],dealloc:52,debian:52,debian_10:52,debian_10_64:52,debian_11:52,debian_11_64:52,debian_12:52,debian_12_64:52,debian_4:52,debian_4_64:52,debian_5:52,debian_5_64:52,debian_6:52,debian_6_64:52,debian_7:52,debian_7_64:52,debian_8:52,debian_8_64:52,debian_9:52,debian_9_64:52,debug:[52,97],deca:1,deci:1,decid:[51,52,77,97],decim:[46,97,98],declar:[1,13,47,52,77],decommiss:1,decreas:97,decrypt:[2,4,66,89],dectect:18,dedic:[11,13,52],dedicated_failover_host:13,deem:96,default_answ:[2,52],default_choic:52,default_config:13,default_datastore_id:52,default_gatewai:[3,11,52],default_image_registri:52,default_image_repositori:52,default_ingress_tls_certif:[52,78],default_kubernetes_service_content_librari:52,default_messag:[1,2,4,46],default_pod_cidr:52,default_service_cidr:52,default_url:[2,11],default_vm_restart_prior:13,defaultansw:2,defaultgatewai:[3,11],defaultkubernetesservicecontentlibrari:[52,77],defaultpolici:52,defaults_cli:[0,1,20,103],defaultvalu:52,defaut:2,defer:52,defer_import:52,defin:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,27,28,33,34,35,36,37,40,41,42,43,46,47,49,51,52,55,64,65,71,74,75,76,77,78,81,83,84,87,89,90,96,97,98,99,100,101,102],definit:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,48,49,50,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100],definiton:47,defint:47,degrad:[2,13,52,77,96],degre:[2,75,97],delai:[1,13,15,77,97],deleg:[1,11],delet:[1,2,4,8,14,15,16,17,23,24,26,29,40,41,44,46,47,51,52,54,64,65,66,72,74,75,77,80,87,90,91,95,97,98,99,101],delete_task:[23,24,41,87,90,91,92,95],delete_with_credenti:52,deletecertfromtruststor:1,deleted_properti:24,deletelibraryitem:[15,101],deletelocallibrari:1,deleteresult:23,deletesubscribedlibrari:1,deletesubscript:15,deletioninfo:24,delimit:[1,52],deliv:1,dell:20,delta:1,demand:[1,15,52],deni:[1,2,3,11,52],denot:[52,74,98],depdend:13,depend:[1,13,15,16,17,20,21,24,46,52,63,77,97],dependency_error:24,dependency_rul:13,dependencyerror:24,dependencyrul:13,depends_on_vm_group:13,deploi:[1,11,47,52,64,65,68,75,77,96],deploy:[0,1,2,4,11,52,75,96,103],deploy_task:52,deployableident:52,deployment_cli:[0,1,68,69,103],deployment_count:52,deployment_count_unset:52,deployment_opt:52,deployment_s:52,deployment_spec:52,deployment_typ:[52,96],deploymentcount:52,deploymentopt:52,deploymentoptionparam:52,deploymentoptionsect:52,deploymentresult:52,deploymenttarget:52,deploymenttyp:[52,96],deployplacementspec:52,deployspec:52,deployspecdiskstorag:52,deployspecdiskstoragepolici:52,deployspecvmhomestorag:52,deployspecvmhomestoragepolici:52,deploytempl:52,depo:75,depot:[0,1,20,23,24,37,41,103],depot_cont:[0,1,20,23,103],depot_content_cli:[0,1,20,103],depotextractinfo:23,depotoverrid:23,depots_cli:[0,1,20,38,103],deprec:[1,3,11,23,28,52,64,65,98],deprecatedvcalert:11,depth:13,der:16,deriv:[1,23,52,66,80,89,97],descipript:20,descr:1,describ:[1,2,3,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,47,51,52,53,54,55,61,62,63,64,65,66,67,71,74,77,78,80,81,87,88,89,90,91,92,93,95,97,98,99,101],descript:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,19,20,23,24,26,27,28,31,33,34,35,36,37,39,40,41,42,43,45,46,47,51,52,55,57,59,60,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102],description_kei:[2,52],descriptor:[1,17,18,52],descriv:1,design:[1,47,52],desir:[1,2,3,8,20,23,24,25,26,27,28,29,30,32,34,35,36,41,42,43,44,51,52,65,66,77,87,90,95],desired_st:8,desired_valu:8,desired_vers:77,desiredst:8,desktop:[52,97],despit:77,desrib:31,destin:[1,2,3,4,11,15,52,98],destination_create_spec:15,destinationspec:[1,15],destroi:[52,97],detach:[14,97],detach_multiple_tags_from_object:14,detach_tag_from_multiple_object:14,detail:[1,2,4,5,8,13,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,49,52,54,55,63,64,65,66,67,71,74,75,77,80,83,84,87,88,89,90,91,92,93,95,97,98],detailedvalidationerror:24,detect:[1,15,18,23,24,52,71,75,97],determin:[1,3,11,12,13,15,16,17,20,23,26,28,52,66,77,87,89,95,97,98,99,100],dev:52,develop:[1,45,97],devic:[1,2,13,15,20,21,28,31,51,52,88,89,97,98,99],device_access_typ:97,device_constraint:21,device_count:28,device_id:52,device_reclassif:31,deviceaccesstyp:97,deviceconstraint:21,devicehclinfo:21,deviceid:52,devicenam:28,devices_hcl:21,devop:52,dhcp:[1,3,11,52,77,81,97,98],dhcp_enabl:[77,81],dhcpconfiginfo:[97,98],diagnost:[2,46,52],dict:[1,2,4,5,8,11,20,22,23,24,25,28,29,31,38,41,44,46,47,52,63,77,80,83,84,89,97,100],dictat:[11,13,52,77],did:[1,20,23,28,43,51,52],didn:51,diff_result:8,differ:[1,2,3,8,11,14,15,16,20,23,24,28,41,43,46,47,51,52,77,87,95,97,98,99],differenti:[1,52],difficult:[2,75],difficulti:[2,75],diffresult:8,digest:[46,89],digit:[1,2,4,11,46,52,54,97,98],dik:97,direct:[1,2,11,14,16,17,52,91],direct_feder:52,directli:[16,17,52,78,81],directori:[11,17,51,52,68,97,98,100],directory_not_empti:98,directpath:52,dirti:52,disabl:[1,2,4,6,11,13,15,23,24,27,33,34,51,52,57,71,77,81,96,97,98],disable_dpm:[24,27,33,34],disable_drs_vmot:57,disable_drs_vmotion_cli:[0,1,52,55,56],disable_hac:[24,27,33,34],disabledrsvmot:57,disagr:1,disallow:77,disambigu:1,disassoci:52,discard:[71,101],disclaim:[28,52,77],disclos:[1,51],disconnect:[1,24,97],disconnect_all_n:1,discourag:15,discov:[1,46,51,52,75],discover:21,discoveri:[52,80],discovery_cli:[0,1,52,103],discovery_endpoint:52,discret:[2,52],discrimin:[45,51,55,57,59,60],discript:37,disjoint:[1,52,101],disk:[1,2,13,15,16,18,19,51,52,77,83,84,97,98,99,100,101],disk_capac:18,disk_control:18,disk_storag:52,disk_storage_overrid:52,diskclonespec:1,diskcontrol:18,diskcontrollersubtyp:18,diskcontrollertyp:18,diskinfo:52,diskpolicyspec:97,diskprovisioningtyp:52,diskrelocatespec:1,disks_to_remov:[1,52],disks_to_upd:[1,52],disksect:52,diskspec:52,diskstorag:52,diskstorageinfo:52,diskstorageoverrid:52,diskupdatespec:52,dispatch:51,displai:[1,2,14,18,20,22,23,24,28,37,40,41,46,47,51,52,77,80,92,98],display:18,display_nam:[20,22,23,24,28,37,40,41,47,52,77,80,92],display_path:24,display_vers:[20,22,23,24,37,40,41],displaynam:92,disposit:52,disregard:52,dissoci:75,distinct:[20,95],distinguish:[52,54],distribut:[1,13,24,52,65,78,79,81,97],distributed_port:97,distributed_portgroup:[1,52,97],distributed_switch:[52,78,79],distributed_switch_uuid:97,distributed_switches_cli:[0,1,52,77,78],distributedswitch:[78,79],distributedswitchcompat:52,distributedvirtualportgroup:52,distributedvirtualswitch:[52,78,79],diverg:[87,95],dn:[1,3,11,20,23,52,54,68,70,77,78,97,98],dns_client:[0,1,2,103],dns_domain:52,dns_label:52,dns_server:[52,68],dns_server_configur:11,dns_suffix_list:52,dns_valu:[97,98],dnsassignedvalu:[97,98],dnsconfiginfo:[97,98],dnsinfo:1,dnsmode:1,dnsserverconfig:[1,3],dnsserverconfigur:11,dnsservermod:[3,11],do_not_change_vms_power_st:[24,27,33,34,35,36,41,42],doc:52,doc_structur:23,docker:[52,65,77],document:[1,20,23,24,25,26,27,28,29,30,33,34,35,36,41,42,43,44,47,51,52,64,77],documentstructur:[23,24],doe:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,23,24,25,26,27,33,34,40,41,45,47,48,49,50,51,52,54,55,57,59,61,64,65,66,74,77,78,79,80,82,83,84,96,97,98,100,101,102],doesn:[1,2,4,17,20,23,24,31,46,47,51,52,55,62,63,75,77,83,87,91,97,99],domain1:98,domain:[3,11,15,52,54,63,68,72,77,78,97],domain_:52,domain_nam:[52,97],domain_password:52,domain_usernam:52,domainnam:52,doman:3,domin:15,don:77,done:[1,2,15,16,20,24,27,28,31,33,34,35,36,41,42,47,52,62],dot:[12,47,97,98],doubl:47,double_valu:47,down:[1,2,11,13,39,40,52,71,77,97],downgrad:51,download:[1,2,11,16,17,20,21,23,52,66,75,92,98],download_endpoint:17,download_file_token:52,download_session_id:[16,17],download_token:66,downloadsess:[16,17,52],downloadsession_cli:[0,1,15,16,103],downloadsessionmodel:16,downlooad:1,dp:1,dpm:[1,13,24,27,33,34],dpm_enabl:13,dpm_threshold:13,dpmbehaviorinfo:13,dr:[1,11,12,13,51,52,57],draft:[1,20,23,24,25,26,28,41,43,52],draft_appli:24,draft_check_compli:24,draft_creat:24,draft_delet:24,draft_export_config:24,draft_get:24,draft_id:24,draft_import_from_host:24,draft_list:24,draft_precheck:24,draft_show_chang:24,draft_task:25,draft_upd:24,draftid:24,draftimportresult:[24,26],drafts_client:[0,1,20,23,24,41],drafttask:25,drift:[20,24],drive:[1,18,31,52,97,99],driven:52,driver:[20,21,28,31],driver_nam:[28,31],driver_vers:[28,31],driverfirmwarevers:28,drop:[3,11,71],drs_client:[8,9,10,11,12],drs_enabl:1,drs_vm_overrid:12,drsbehaviorinfo:[11,13],drsconfig:[11,12,13],drsvmoverrid:[12,13],dry_run:66,ds:[8,15,16,17],dt:46,due:[1,8,20,23,24,28,41,51,52,54,97,99],duplic:[3,11,15,24,89,98],duplicate_instance_id:24,durat:[1,5,51,54],dure:[1,2,4,5,6,8,11,13,15,16,17,20,23,24,26,27,28,33,34,35,36,38,41,42,43,47,52,54,75,77,80,91,96],dv:81,dvd:18,dvpg:[52,81],dynam:[1,2,47,51,52,97],dynamic_direct_path_io_devic:52,dynamic_structur:47,dynamicdirectpathiodevic:52,dynamicid:[1,2,4,5,8,14,20,46,51,52],e1000:97,e:[1,2,4,11,13,20,23,24,28,39,40,45,46,51,52,62,63,77,78,89,90,95,97,98],each:[1,2,4,12,14,15,16,20,21,23,24,28,47,51,52,54,55,57,62,63,64,75,77,82,91,92,94,97,98,99,101],eager:52,eagerzeroedthick:52,earli:[1,8,11,57,59,97],earlier:[16,51,52],earliest:[2,78],easi:47,easier:[1,20],easili:91,ecc:89,ecc_nist_p_256:89,echo:52,ecomst:52,ecomstation_2:52,ed:[23,37],edg:[52,77,78,79],edge_clust:[52,78,79],edge_cluster_id:78,edgeclustercompat:52,edgeprovid:78,edges_cli:[0,1,52,77,103],edit:[1,14,52,83,84,100],editpool:1,effect:[1,2,3,15,16,17,20,23,24,27,29,34,36,41,42,44,47,51,52,54,97],effectivecompon:[24,29,41,44],effectivecomponentdetail:20,effectivecomponentinfo:[20,24,29,41,44],effectivepolicyspec:[23,24,27,34,36,42],effici:[17,47,97],effort:1,efi:[89,97],efi_legacy_boot:97,efi_tcg2_event_log_format_tcg_2:89,eg:1,egress:[52,77],egress_cidr:52,egress_ip_rang:78,ehci:18,ehci_pci_slot_numb:18,eight:[97,98],either:[1,11,13,15,16,17,20,21,23,24,41,47,52,78,80,91,96,97],ek:[89,91],elaps:97,element:[1,14,46,47,48,49,50,51,52,55,98],element_illeg:52,element_requir:52,element_typ:47,element_unknown:52,elementmap:47,elementvalu:47,elen:47,elif:52,elig:[2,14,26,52],eligibilityresult:26,ellig:26,els:[20,29,44,52,77,96,102],email:[1,11,23,37,54],email_address:[23,54],emailaddress:54,emb:97,embed:[1,2,4,52,77],embodi:97,emc:[17,52],empow:52,empti:[1,2,3,4,8,11,12,13,14,15,16,17,20,23,24,26,28,41,46,47,51,52,54,55,62,63,66,67,75,77,78,79,81,83,84,87,88,89,90,91,92,93,94,95,97,98,99,100],empty_properti:24,emul:[97,99],emulationtyp:97,en:[52,77],en_u:46,enabl:[0,1,2,4,5,6,11,12,13,15,16,18,20,23,24,27,33,34,35,36,41,42,47,52,64,65,71,77,78,81,95,96,97],enable3d:18,enable_ad_iwa_id:11,enable_ceip:11,enable_cloud_admin_role_protect:11,enable_csp_oidc_feder:11,enable_deprecated_vc_alert:11,enable_file_browser_download_upload_from_vc:11,enable_hybrid_manag:11,enable_idp_configur:11,enable_in_progress:26,enable_intercom_chat:11,enable_list_major_upgrade_vers:2,enable_on_compute_clust:52,enable_on_zon:52,enable_quick_boot:[24,27,33,34,35,36,41,42],enable_ssl_cert_valid:11,enable_task:[24,26,41],enablement_cli:[0,1,20,23,103],enableoncomputeclusterspec:52,enableonzonesspec:52,enableresult:26,enablespec:[24,41,52],encapsul:[16,52,90],enclav:61,encod:[1,16,23,24,26,47,52,54,66,77,78,80,97],encount:[8,23,24,28,43,51,52,62,63,75,83],encrypt:[2,4,11,52,66,89],encryption_kei:2,end:[1,2,4,8,23,24,26,46,52,54,77,97,98],end_certif:1,end_index:98,end_mark:52,end_of_data:[52,98],end_tim:[1,2,4,5,8,14,20,23,24,28,43,52,97],end_timestamp:5,endors:[89,91],endorsementkei:[89,91],endpoint:[1,15,16,17,23,24,41,51,52,77,78,80,81,82,90],endpoint_typ:17,endpointtyp:17,endtim:[8,24],enforc:[13,24,27,33,34,47],enforce_hcl_valid:[24,27,33,34],engin:[24,41,52],english:[1,2,4,46,47],enhanc:[23,37,52,96],enough:[1,51,78],enpoint:[23,24,41],ensur:[1,11,12,17,24,52,77,81,89,98],ensureaccess:77,enter:[1,11,12,24,27,33,34,35,36,41,42,77,78,97],enter_setup_mod:97,entering_mainten:12,enterpris:52,entir:[15,24,41,52,80,91],entireti:[52,77],entiti:[1,11,12,13,14,20,23,24,28,41,43,47,49,51,52,61,63,74,77,83,84,98,100,102],entitit:[23,28],entity_metadata:102,entity_result:[23,28,43],entitycheckresult:[23,28,43],entityid:23,entitynam:23,entitytyp:[23,28,43],entri:[1,2,12,15,17,20,21,24,28,31,52,77,89,97,99],entropi:71,entropy_cli:[0,1,52,103],entrycreatespec:[1,99],enumer:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,72,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100],enumeration_id:47,enumerationinfo:47,enumerationvalueinfo:47,environ:[1,2,8,11,23,52,54,57,59,64,75,77,87,95,97],environemnt:75,environment_vari:97,ephemer:[52,77,97],ephemeral_storage_polici:[52,77],epoch:[1,2],equal:[1,15,23,52,54,77],equal_al:1,equival:[1,5,23,39,40,52,55,62,66,67,77,78,79,82,88,89,93,98,100],error:[1,2,3,4,5,6,8,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,47,51,52,53,54,61,62,63,64,65,66,67,70,71,72,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],error_count:75,error_descript:45,error_messag:[1,14,16,17,52,93],error_typ:51,error_uri:45,errorcondit:52,errorinfo:47,errormessag:52,errorreason:98,errors_cli:[0,1,2,3,4,5,6,8,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,48,49,50,52,53,54,55,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,103],errortyp:24,escap:[1,97],essenti:[2,28,61],establish:[1,47,51,52,80,87],estim:[2,52,75],estimated_export_tim:52,estimated_import_tim:52,estimated_time_to_instal:2,estimated_time_to_rollback:2,estimated_time_to_upd:75,estimatedtimetoinstal:2,estimatedtimetorollback:2,esx01:97,esx:[0,1,52,71,87,92,97,98,103],esx_client:[1,52,87,90,91],esxi:[1,20,21,23,24,27,28,30,32,33,34,35,36,41,42,43,52,97],esxicompatibilityreleas:21,etc:[1,2,12,20,24,41,46,47,52,81,89,98],eth0:1,ethernet:[1,12,15,52,97,98,99],ethernetinfo:52,ethernetupdatespec:52,eula:[2,23,52,77],europ:52,evacu:[24,27,33,34,52,55,56,57,58],evacuate_offline_vm:[24,27,33,34],evacuation_cli:[1,52,55,56,57],evalu:77,even:[1,2,11,12,13,15,20,52,97],event:[13,15,52,77,89],eventlog:89,events_task:52,ever:[24,41],everi:[1,15,18,20,23,24,28,47,51,52,62,81,93],everydai:[4,11],everyon:65,everyth:98,evict:[1,15],evictlibraryitem:15,evictsubscribedlibrari:1,evolv:1,ex:[1,24,72,97],exa:1,exact:[28,46,47,51],exactli:[15,52,77,97],examin:52,exampl:[1,2,3,4,5,11,12,13,14,15,16,17,20,22,23,24,28,31,41,46,47,51,52,54,64,74,77,81,91,97,98,101],exbi:1,exce:[1,2,11,12,13,15,23,45,52,87,98],exceed:[1,101],except:[1,2,4,5,8,14,15,16,20,24,45,46,47,51,52,54,57,63,65,70,77,99,100],excess:51,exchang:[1,52],exchangespec:52,exclud:[1,24,41,52,81],exclude_kei:52,exclude_result:1,exclus:[23,28,43,97],execut:[1,2,4,5,6,13,15,16,17,20,21,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44,46,47,52,53,54,55,62,66,74,75,87,89,91,92,95,96,97,101],execute_url:75,executing_script:52,exisit:24,exisitng:52,exist:[1,2,3,4,5,8,11,13,14,15,16,17,20,21,23,24,26,29,31,41,43,44,47,48,49,50,51,52,54,55,64,65,66,69,77,80,87,90,91,93,94,96,97,98,101],existing_migration_assist:52,exit:[1,52,78,81,97],exit_cod:97,expand:[1,11,12,16],expandable_reserv:[1,11,12],expandablereserv:1,expect:[1,3,11,16,24,47,51,52,81,89,98],expected_revis:24,expected_typ:24,expectedrevis:24,experi:[11,20,21,52],experienc:[2,24],experiment:1,expir:[1,2,11,16,17,20,45,46,51,52,66,74,97],expiration_tim:[1,16],expired_certif:[17,52],expires_in:[1,52,74],expiri:[20,52,66],explain:[20,52,102],explan:[24,41,47],explanationdetail:[24,41],explicit:[2,11,15,47,51,52,77],explicitli:[1,2,12,16,81,97,99,100],exploit:[2,75],export_config:[23,24,26],export_error:52,export_iso_imag:23,export_offline_bundl:23,export_schema:26,export_software_spec:23,export_tim:66,exportconfig:24,exportflag:52,exportresult:[23,24,26,66],exportspec:[23,66],exporttyp:[23,66],expos:[1,46,47,51,52,77,90],express:[1,52,77,98],ext3:97,extend:[1,2,16,54],extended_key_usag:54,extens:[23,46,52,54,61,77,97],extern:[52,61,68,69,71,73,74,77,78,81,93],externalpool:71,extra:[1,16,18,52,71],extra_config:52,extraconfig:52,extraconfigparam:52,extract:[20,23,89],extractdepot:23,extractresult:23,extrem:[2,75],facet:46,facil:1,facilit:[51,52],fact:[40,51,52],factor:[1,52],factori:46,fail:[1,2,3,4,5,8,11,13,14,15,16,17,20,23,24,26,27,28,33,34,35,36,41,42,51,52,54,57,63,64,65,66,75,77,87,91,93,96,97,98,99,100,101],failed_clust:63,failed_host:[23,24,28],failed_login_attempt:11,failedwithsystemerror:[52,77],failov:[13,52,96],failover_ip:[52,96],failover_task:52,failur:[1,2,3,8,11,13,14,15,16,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,52,63,68,69,75,91,97,98,100],failure_act:[24,27,33,34,35,36,41,42],failure_caus:100,failure_interv:[11,13],failure_reason:1,failureact:[24,27,33,34,35,36,41,42],failures_and_respons:13,failuresandrespons:13,fall:[1,52,98],fallback:[46,52],fals:[1,2,11,13,14,15,17,24,41,47,52,63,77,78,80,81,96,97,98],famili:[52,89,97],far:[17,52],fashion:52,fast:[2,4,5,26],fast_backup:[2,4,5],fast_track:26,faster:1,fatal:[52,64,96],fault:[1,51,52,97],favor:13,fc00:[3,11],fe04:[97,98],fe94:[3,11],feasibl:[13,59],featur:[0,1,2,8,11,13,15,20,24,28,31,41,51,52,57,59,61,75,77,79,85,103],feature_in_us:51,featureinus:[2,4,51],feder:[11,52],federation_typ:52,federationtyp:52,fedora:52,fedora_64:52,feedback:[1,8,11,57,59],femto:1,fetch:[8,14,17,23,24,28,43,46],few:1,fewer:[47,52],fi:52,field:[1,2,4,11,13,14,15,16,20,23,24,26,28,31,38,45,46,47,49,51,52,54,66,75,77,78,79,80,90,97,98],field_nam:47,fieldinfo:47,fieldsthat:23,figur:[47,52],file:[1,2,11,12,15,16,17,18,20,21,23,24,26,41,46,47,48,50,51,52,77,92,97,98,101,102],file_attribut:98,file_id:[23,24,41],file_nam:[16,17,23,46],file_not_found:98,file_path:98,file_spec:17,file_too_larg:98,fileattributesinfo:98,fileattributesupdatespec:98,filecreationattribut:98,fileerrordetail:[97,98],fileloc:[51,52],filenam:[26,98],filepath:[46,102],filespec:26,filesystem:[97,98],filesystem_cli:[0,1,52,97,103],filesystem_famili:98,filesystemfamili:98,fileupload:[23,24,41],fill:[52,98],filsystem:98,filter:[1,5,14,15,16,23,24,39,40,41,52,55,62,66,67,77,78,79,82,83,84,87,88,89,93,95,98],filter_spec:[1,5,66,67],filterspec:[1,5,23,24,39,40,41,52,55,62,66,67,77,78,79,82,83,84,87,88,89,92,93,95,98],filterspecv2:52,filtrat:[87,95],find:[1,15,24,41,51,52,77,97],findspec:[1,15],finest:1,fingerprint:[47,52],finish:[4,12,16,17,25,52,97,98],fip:6,firewal:[3,11],firewall_cli:[0,1,2,103],firewall_rule_polici:11,firewallrulepolici:11,firmwar:[20,21,28,31,88,97],firmware_vers:[28,31,88],firmware_version_match:28,firmware_version_unknown:28,firmwareversionmatchingcriteria:28,first:[1,2,3,15,16,24,41,47,51,52,54,65,91,98,102],firstboot:4,firstnam:52,firwar:28,fit:[1,51,52],five:[1,13,16],fix:[1,2,11,12,13,23,37,51,52,75],fixed_nam:52,fixedsizeslotpolici:13,flag:[1,2,4,5,8,11,12,13,14,15,17,20,23,24,26,28,31,52,71,75,83,97],flag_as_incompat:31,flash:1,flat:52,fllesystem:98,floating_ip:52,floating_ip_address:81,floppi:[1,18,97,99],flow:[52,80],flush:[23,52],flush_task:23,flushresult:23,fo:[1,11,12],folder:[1,11,12,15,17,51,52,101,102],folder_cli:[7,8,9,10,11],folder_id:52,folderdetail:12,follow:[1,2,3,4,11,13,15,16,17,20,21,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44,46,47,52,53,54,55,62,63,65,66,67,71,74,75,77,87,88,89,91,93,95,96,97,98,99,101,102],forc:[1,2,3,11,13,15,52,54,77],force_add:1,force_delet:52,force_sync_cont:15,forceadd:1,forcefulli:[1,15],forcesynccont:15,foreign:52,forev:[4,11],form:[2,16,17,39,40,46,51,52,80],formal:1,format:[1,2,4,11,15,16,17,23,46,47,52,54,64,66,75,77,81,89,91,92,93,98],formatt:47,formattertyp:47,formed:52,forum:54,forward:[2,11,97],found:[1,2,3,8,15,16,20,21,23,24,25,26,27,28,30,33,34,37,41,51,52,64,65,66,67,71,74,77,80,87,88,89,90,91,92,93,94,95,97,98,99,101],four:[97,98],fqdn:[2,3,11,21,82],fraction:[1,46],frame:[24,97],framework:[47,52],free:[1,15,16,23,52,97],free_spac:[1,97],freebsd:52,freebsd_11:52,freebsd_11_64:52,freebsd_12:52,freebsd_12_64:52,freebsd_13:52,freebsd_13_64:52,freebsd_14:52,freebsd_14_64:52,freebsd_64:52,frequenc:[23,52,64],fridai:[2,4,11,23,64],friednli:52,friendli:[24,52,79,87],frobozz:[20,23,39,40],from:[1,2,3,11,12,13,14,15,16,17,18,20,23,24,25,26,28,29,30,31,37,41,43,44,46,47,51,52,54,57,59,62,63,65,66,71,72,74,75,77,78,80,81,87,89,91,92,93,95,96,97,98,99,100,101,102],front:[1,23,52,78],frontend:52,frozen:1,ftp:[2,4,11],fulfil:[51,52,77],full:[1,11,16,20,23,24,39,40,46,52,87,97],full_dat:46,full_date_tim:46,full_nam:[1,52,97],full_tim:46,fulli:[1,2,3,16,17,47,52,77,80],fullnam:[1,11],fully_autom:[11,13],functiontyp:1,fundament:1,funtion:[91,92],further:[1,3,20,21,28,52],fusion:97,futur:[1,15,20,29,31,39,40,44,52,57,66,75,89,98,101,102],g:[1,2,20,23,28,39,40,45,46,51,52,77,89,90,95,97,98],ga:5,gain:52,garbag:[64,65],garbage_collect:64,garbagecollect:64,gatewai:[3,11,52,77,78,80,98],gateway_address:[77,98],gateway_ip:52,gather:[1,77],gender:46,gener:[1,2,3,4,6,8,11,12,13,14,15,16,17,18,20,21,23,24,26,28,37,41,43,47,51,52,53,54,64,65,66,67,71,74,75,77,78,80,81,87,88,89,91,92,93,94,95,97,98,102],generate_error:52,generate_task:[24,41],generated_at:21,generation_tim:1,generic_instanti:47,generic_linux:52,generic_typ:47,genericinstanti:47,generictyp:47,genx:[39,40],get:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,40,41,42,43,44,47,48,49,50,51,52,53,54,55,57,59,60,63,64,65,66,67,70,71,72,74,75,77,78,79,80,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],get_default:1,get_task:[87,90,91,92,93,94,95],get_v2:52,getconfigur:1,getspec:1,gibi:1,gid:98,giga:1,gigabyt:1,give:[2,8,13,15,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,52,75],given:[1,2,3,4,5,8,11,14,15,16,17,20,21,23,24,27,28,29,31,33,34,37,38,39,41,44,49,52,54,62,68,75,77,78,79,80,82,83,84,87,90,91,95,97,98,99],global:[1,2,3,6,11,15,52,96],global_dns_set:52,global_permiss:11,globaldnsset:52,globalfip:6,globalpermiss:11,gnu:52,go:[1,16,24,52,54,77],goe:71,gold:20,good:23,grai:[2,13,52],gram:1,grant:[1,45,52],grant_typ:52,granular:[47,97],graphic:[1,18],graphics_memory_s:18,grave:52,greater:[16,20,21,23,28,97],green:[2,3,13],grid:[52,77],group:[1,2,11,12,13,14,18,19,20,24,41,47,51,52,72,80,81,82,87,91,95,97,98],group_id:[19,52,98],group_nam:[52,72],groupdetail:13,groupid:87,groupnam:1,groups_base_dn:52,groups_claim:[52,80],groupsclaim:80,grow:[1,11,12,14],guarante:[1,8,11,12,13,15,16,17,24,27,33,34,52,57,59,64,76,98],guard:[52,61],guess:52,guest:[0,1,2,13,51,52,75,97,99,103],guest_client:[0,1,98,103],guest_custom:52,guest_customization_spec:1,guest_o:[1,52],guest_operations_readi:97,guestcustomizationspec:[1,52],guestfil:98,guesto:[1,13,52,97],guestoper:[97,98],guestosfamili:[52,97],gui:[1,2,51],gui_run_once_command:52,gui_unattend:52,guid:[1,15,21,28,31,52],guirunonc:52,guiunattend:52,ha:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,33,34,35,36,41,42,46,47,50,51,52,54,55,68,71,75,77,82,87,91,92,93,95,96,97,98,99,100,101,102],ha_client:[8,9,10,11,12],ha_en:1,ha_ip:[52,96],ha_network:52,ha_network_nam:52,ha_network_typ:52,ha_proxi:52,ha_proxy_config_create_spec:52,ha_proxy_config_set_spec:52,ha_proxy_config_update_spec:52,ha_proxy_info:52,ha_vm_overrid:12,had:[1,51,52],hadrwar:23,halt:1,hand:20,handl:[1,46,47,51,52,89],handoff:90,handshak:1,hanetwork:52,hanetworktyp:52,happen:[1,8,12,15,20,24,33,34,51,52,77,96,97],haproxi:[52,78],haproxyconfig:78,haproxyconfigcreatespec:52,haproxyconfigsetspec:52,haproxyconfigupdatespec:52,haproxyinfo:52,harbor:[64,65],harbor_cli:[0,1,52,64,103],hard:[2,18,83,97],hardwar:[0,1,12,20,21,23,24,27,28,29,31,33,34,39,40,51,52,83,84,87,88,91,97,98,100,103],hardware_cli:[0,1,52,87,99,103],hardware_compat:[20,23,24,28,30],hardware_compatibility_cli:[1,20,23,24,28],hardware_custom:52,hardware_modul:20,hardware_support:[0,1,20,23,103],hardware_support_cli:[0,1,20,103],hardware_support_packag:20,hardware_vers:1,hardwarecompat:[20,21,28,30,31],hardwarecustomizationspec:52,hardwaremoduleclass:20,hardwaremoduledetail:20,hardwaremodulefirmwarecompli:20,hardwaremodulefirmwareinfo:20,hardwaresupport:[20,24,29],hardwaresupportinfo:[20,24,29],hardwaresupportmanagerinfo:23,hardwaresupportmanagersummari:23,hardwaresupportpackagecompli:20,hardwaresupportpackageinfo:[20,28,39],hardwaresupportpackagespec:20,hardwaresupportpackagesummari:23,hardwaresupportpackagevers:23,hardwaresupportspec:[20,29],harwar:28,has_error:17,has_fields_of:47,has_password:[1,11],hasfieldsof:47,hash:[1,15,16,20,23,52,89],hashalgorithm:89,hasn:[8,17,20,24,41],hat:52,haul:1,have:[1,2,3,4,5,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,47,48,50,51,52,53,54,55,57,62,63,64,65,66,67,71,74,75,77,78,79,80,82,83,84,87,88,89,93,95,97,98,99,100,101,102],havmoverrid:[12,13],hbdatastorecandid:13,hcl:[0,1,20,24,27,28,30,33,34,103],hcl_client:[0,1,21,103],hcl_data_unavail:28,hclreport:21,he:[51,52,84],header:[1,20,51,52,66],health:[1,2,3,13,20,23,24,26,52,64,66,67,87,90,91,92,95],health_client:[0,1,103],health_except:52,health_messag:[2,52],health_set:1,health_stat:52,health_status_messag:52,health_warn:52,healthcheckset:1,healthi:[2,52,87,90,96],healthlevel:2,healthspec:1,healthstatu:52,healthy_with_warn:[2,52],heart:13,heartbeat:[1,13,52,96],heartbeat_datastor:13,heartbeat_datastore_polici:13,heartbeatdatastor:13,hecto:1,hello:1,helloresult:1,hellospec:1,help:[1,11,20,39,40,45,47,51,52],help_url_pointing_to_aw:11,henc:[3,14,54],here:[14,15,24,52,77],hertz:1,hexadecim:[1,52,66,97,98],hexadem:52,hh:11,hidden:98,hide:15,hierarchi:[12,24,47],high:[1,2,11,12,13,16,28,47,52,96],higher:[13,98],highest:[13,24,41],hint:98,histor:[1,5,52],histori:[16,52],historymigrationopt:52,historymigrationspec:52,hmac:52,hok:11,hok_refresh:11,hold:[24,46,52,77,80],holder:[46,47],home:[1,52,83,84,97,100],homogen:52,honor:52,hop:98,hopkinton:[17,52],host:[0,1,2,11,12,13,15,20,21,23,24,25,26,27,28,30,32,33,34,39,51,52,54,57,59,61,64,66,75,77,78,87,91,92,93,95,97,98,99,101,103],host_client:[0,1,7,8,9,10,11,103],host_compli:24,host_credenti:[20,23],host_devic:[52,97],host_fail_over_slot_polici:13,host_failures_cluster_toler:13,host_fold:1,host_group:13,host_id:[52,61],host_id_to_uuid:24,host_impact:28,host_info:[20,23,24,26,28,43],host_isolation_respons:13,host_monitor:13,host_nam:[20,23,52,97],host_not_found:1,host_ori:24,host_precheck:24,host_specific_in_profil:24,host_specific_key_in_overrid:24,host_statu:[23,24,28],host_tag:57,hostbusadaptertyp:97,hostcompli:[20,24,41],hostconfig:[11,12],hostcredenti:[20,23],hostdefaultinfo:13,hostgroup:13,hostimpact:43,hostinfo:[20,23,24,26,28,43],hostnam:[1,2,3,11,15,20,24,52,54,75,77,78,87,91,97,98],hostnamegener:52,hostprecheckresult:24,hostresult:24,hosts_client:[0,1,43,52,103],hosts_unavail:28,hostsconfig:52,hostserviceticket:[20,23],hoststatu:[23,24],hostsystem:[1,15,20,21,22,23,24,26,28,41,42,43,44,52,57,61,67,71,87,88,89,101],hot:[51,97,99],hot_add_en:97,hot_add_increment_size_mib:97,hot_add_limit_mib:97,hot_remove_en:97,hotadden:97,hotaddincrements:97,hotremoveen:97,hour:[1,2,4,11,23,64,74],hourli:23,hours2:1,hours6:1,how:[1,2,3,11,15,17,20,23,24,27,28,33,34,35,36,41,42,43,47,52,64,75,77,81,97,98,102],howev:[1,3,11,12,16,17,23,52,87,90,91,92],hsm:[20,23,28,39,40],hsp:[20,23,24,29,39,40],html:[3,11,23,47,52,97],http:[1,2,3,4,11,15,16,17,20,23,24,41,46,51,52,66,70,77,80,81,97,98],http_proxy_config:[52,81],https_port:[15,52,70],https_proxy_config:[52,81],hub:[52,77],human:[1,15,20,22,23,28,37,40,43,45,46,51,52,77,78,79],hvc:[0,1,52,103],hvc_client:[0,1,103],hw:74,hybrid:[11,52,72],hyper:52,hypervisor:61,hyphen:52,i:[2,4,11,13,24,39,40,46,51,52,62,63,77,78],id:[1,2,4,8,11,13,14,15,16,18,19,20,21,23,24,25,26,28,41,46,47,51,52,54,61,75,77,78,80,81,87,90,91,92,93,94,95,97,98,99,102],id_token:[1,52],id_token_typ:[1,52],id_valu:1,ideaddressinfo:97,ideaddressspec:97,idempot:[1,14,15,16,64],idenfi:52,ident:[0,1,11,47,51,52,61,80,97,103],identif:[1,8,16,52,97],identifi:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,54,55,57,59,60,61,62,63,64,65,66,67,71,74,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],identity_cli:[0,1,77,103],identity_provid:52,identity_sourc:11,identity_source_typ:11,identitysourc:11,identitysourcetyp:11,idl:[46,47,97],idm:52,idm_endpoint:52,idm_protocol:52,idmprotocol:52,idp:11,idp_adf:11,idp_csp:11,idp_vmwareid:11,idp_ws1b:11,idpconfigur:11,ietf:[1,52],ifnon:97,ignor:[1,2,3,4,11,12,15,16,17,23,31,47,52,57,77,81],ignore_precheck_warn:77,ignore_warn:4,ignoreprecheckwarn:77,illeg:52,imag:[20,23,24,28,29,37,39,40,41,44,52,64,65,77,81,92,97],image_fil:97,image_storag:52,image_storage_polici:[52,77],imageregistri:[52,77],imagestoragespec:52,imagesyncconfig:77,imgdb:92,immedi:[1,13,15,17,52,54,97],immut:[77,80],impact:[2,8,20,23,24,26,27,28,33,34,35,36,41,42,43,52,75],impactinfo:24,impacttyp:24,implement:[1,11,13,39,40,46,47,51,52],impli:[1,14,23,77,100],implicitli:[20,52],import_config:24,import_config_task:23,import_from_fil:26,import_from_host_task:[24,26],import_from_imgdb_task:92,import_profile_task:2,import_provid:66,import_software_spec:[24,41],import_specif:52,importflag:52,importfromhost:24,importhistori:52,importprofilespec:2,importresult:[24,66],importspec:[23,24,41,66],impos:66,improv:[2,11,20,21,52],in_compli:13,in_mainten:12,inaccess:[3,11,13,52,97,98],inaccur:52,inact:[1,88],inactive_after_password_expir:1,inactive_at:1,inactive_source_timeout:71,inadvertantli:51,inbound:3,inc:[17,24,27,33,34,35,36,41,42,52,75],includ:[1,2,4,5,8,11,13,14,15,16,17,20,21,24,28,31,40,41,45,46,47,51,52,54,61,71,77,79,81,87,89,96,97,99,100,101,102],include_kei:52,inclus:[1,28],incom:[3,52],incompat:[20,28,52,75,77,78,79],incompatibility_reason:[52,77,79],incompatibilityreason:52,incompatible_count:75,incompatible_data_processing_unit:20,incompatible_devic:28,incompatible_driver_firmwar:28,incompatible_host:20,inconsist:52,incorrect:[51,52,77,78,79],increas:[52,97],increment:[1,14,15,16,18,24,52,77],indefinit:81,independ:[1,11,12,23,28,97,98],independent_compon:23,indetermin:16,index:[23,49,52,89,98,103],indic:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,23,24,26,28,39,40,43,45,46,47,51,52,55,57,59,60,63,71,74,75,77,81,83,87,89,91,92,95,97,98],indirect_feder:52,indirectli:52,individu:[1,3,4,11,13,14,15,16,20,52,77,87,95,97,98],infer:52,infinit:13,info:[1,2,3,4,5,6,8,14,15,16,17,20,23,24,25,26,28,37,38,41,46,47,52,54,55,57,59,60,64,65,66,67,71,74,75,77,80,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],info_typ:[52,55],infom:1,infomr:4,inform:[1,2,3,4,5,8,11,12,14,15,16,17,18,19,20,21,22,23,24,26,28,29,31,37,38,40,41,43,44,45,46,47,48,49,50,51,52,54,55,57,59,60,63,64,65,66,67,68,69,70,71,74,75,76,77,78,79,80,82,83,84,87,88,89,90,91,92,95,96,97,98,99,100,101],infov2:52,infraprofil:2,infraprofile_cli:[0,1,103],infrastructur:[1,46,47,51,52,77,81,87,90],infrastructureiniti:[52,77],infraupdateha:[12,13],infraupdatehaconfig:13,ingress:[52,77,78],ingress_cidr:52,inherit:[1,52,77,81],init:52,initi:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],initial_config:[0,1,52,68,69],inlin:[52,77],inner:89,inod:98,inpend:23,inprogress:4,input:[1,2,11,12,14,21,23,26,46,47,51,52,54,74,77,89,97],inputtyp:2,insecur:[1,2,11],insensit:[1,15,52],insert:98,insid:[11,51,52,61,97,98],inspect:[16,40,52,80],instal:[0,1,2,15,20,22,51,52,64,68,74,75,76,77,97,103],install_attempt_count:52,install_cli:[0,1,52,103],install_fail:1,install_in_progress:1,install_progress:52,install_tim:2,install_typ:52,installed_product:75,installedcompon:22,installedcomponentinfo:22,installspec:52,instanc:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],instance_count:52,instance_id:[24,52],instance_storag:52,instance_uuid:52,instanceid:52,instancestorag:52,instancestoragevolum:52,instant:1,instant_clon:1,instant_clone_frozen:1,instantan:17,instantclon:1,instantcloneplacementspec:1,instantclonespec:1,instanti:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102],instead:[15,17,23,51,52,64,77,97],insuffci:98,insuffic:98,insuffici:[13,39,40,52,89,96],insymse:89,intact:96,integ:[1,12,47,52],integr:[2,11,52,64,75],intel:[20,61],intellig:23,intend:[16,20,23,51,52],intent:[1,20,23,52,55,80],interact:[1,2,51,52,97],interactive_guest_operations_readi:97,interactive_sess:97,intercom:11,interfac:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,49,51,52,54,55,64,65,66,67,71,74,75,76,77,78,81,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100],interface_index:98,interface_nam:[2,3,11],interfaceinfo:[1,2],interfaces_cli:[0,1,2,103],interfacestatu:[2,11],interfer:[15,77],intermedi:[13,52,54,91],intermediari:52,intermitt:[20,23],intern:[1,2,8,16,20,21,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44,52,75,77],internal_error:52,internal_server_error:51,internalservererror:[21,22,51,52],internationaliz:1,internet:[1,2,52,75,98],interop:[52,75],interoper:[52,75,90],interopreport:75,interpret:[16,98],interv:[1,11,13],intervaltyp:1,intervent:[52,65,77],intial:1,introduc:[2,75],invalid:[1,2,3,4,6,8,11,14,15,16,17,20,23,24,26,31,33,35,40,41,45,51,52,54,66,67,68,69,77,87,88,89,90,91,92,93,95,96,97,98,99,101],invalid_argu:51,invalid_credenti:1,invalid_delete_default:24,invalid_element_configur:51,invalid_element_typ:51,invalid_enum_opt:24,invalid_fil:17,invalid_gr:45,invalid_request:[45,51],invalid_scop:45,invalid_typ:24,invalid_union_tag:24,invalid_url:1,invalidargu:[1,2,4,6,8,14,15,16,17,20,23,24,31,33,35,40,41,51,52,54,63,64,65,66,67,68,69,75,77,78,79,80,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,101],invalidelementconfigur:[15,51,96],invalidelementtyp:[1,15,16,51],invalidgr:[45,52],invalidrequest:[45,51,52],invalidscop:[45,52],inventori:[1,7,8,9,10,11,14,20,23,52,77,97,98,101],inventory_cli:[0,1,2,7,8,9,10,103],inventoryauthor:[8,11],inventoryauthorization_cli:[2,7,8,9,10],inventoryauthorizationplugin:11,inventorymanag:[8,11],inventoryplacementspec:1,invoc:[1,14,47,51,52,74,77],invok:[1,8,14,16,17,23,24,26,28,31,47,51,52,74,77,84,93,98,100],invoker_typ:8,invokertyp:8,involv:[1,52,99],invtauthmgmt:8,io:52,ip:[1,2,3,11,20,23,46,51,52,54,68,70,75,77,78,81,82,96,97,98],ip_address:[52,97,98],ip_allocation_polici:52,ip_assign:77,ip_assignment_mod:52,ip_famili:52,ip_manag:81,ip_protocol:52,ipaddress:[54,98],ipaddressinfo:98,ipaddressorigin:98,ipaddressorigintc:98,ipaddressstatu:98,ipaddressstatustc:98,ipallocationparam:52,ipallocationpolici:52,ipallocationschem:52,ipassign:77,ipassignmentmod:52,ipassignmentsect:52,ipconfiginfo:98,ipfamili:52,ipinfo:52,ipmanag:[77,81],ipprotocol:52,iprang:[52,77,78],ipset:52,ipspec:[52,96],ipv4:[1,2,3,11,52,77,78,97,98],ipv4_en:97,ipv4cidr:52,ipv4info:52,ipv4mod:52,ipv4rang:52,ipv4spec:52,ipv6:[1,2,3,11,28,31,52,97,98],ipv6_en:[1,97],ipv6address:52,ipv6info:52,ipv6spec:52,iri:47,irrespect:13,is_ca:54,is_connect:97,is_default:52,is_on_par:11,is_one_of:47,is_self_sign:52,is_stat:[3,11],is_transi:51,is_valid:52,is_vapp_templ:18,is_vsan_wit:20,isca:54,isdefault:52,island:52,isn:[1,51,98],iso:[2,23,52,75,97],iso_cli:[0,1,103],iso_fil:97,iso_imag:23,isol:[2,13,52,61,75],isolationrespons:13,isoneof:47,issu:[1,2,20,23,24,27,28,31,33,34,43,45,52,54,61,66,67,74,75,80,87,89,90,91,92,95,97],issued_token_typ:[1,52],issuer:[17,52,54,80,87,89],issuer_alia:87,issuer_dn:54,issuer_url:80,issuerurl:80,issuespec:52,item:[0,1,2,14,15,16,18,46,52,57,77,81,98,101,103],item_cli:[0,1,15,17,103],item_type_rul:1,itemmodel:[1,15,16],iter:[1,52,98],iterationspec:[1,52,98],its:[1,2,3,5,8,11,14,15,16,17,20,21,22,23,27,28,29,34,39,44,47,51,52,59,63,75,77,80,83,84,91,95,97,98,100,101],itself:[1,20,46,51,77,97],iwa:11,jan:[39,40,46],java:52,javadoc:47,job:[4,5,11,52],job_client:[0,1,2,4,103],job_count:52,job_count_unset:52,jobcount:52,join:[52,68],joul:1,json:[1,2,15,23,24,26,41,46,47,51,52,102],json_str:[24,41],just:[15,47,52],jwt:52,k:52,kb:[1,18,23,37,52],kb_article_link:52,keep:[13,15,16,71],keep_al:16,keep_in_storag:17,keepal:47,kei:[1,2,4,5,8,11,12,17,20,22,23,24,25,28,29,31,38,41,44,46,47,51,52,54,61,63,66,67,77,83,84,87,89,90,91,93,94,95,97,100],kelvin:1,kept:[17,52,81],kernel:52,key_derivation_kei:66,key_id:[66,67],key_in_host_overrid:24,key_serv:90,key_siz:54,key_usag:54,keyservercreatespec:90,keyserverinfo:90,keyserverupdatespec:90,keyusag:54,keyword:47,kibi:1,kill:1,kilo:1,kilobyt:1,kilogram:1,kind:[1,47,51,52],km:[0,1,52,66,67,87,90,95],kmip:[90,93],kmip_serv:90,kmipservercreatespec:90,kmipserverinfo:90,kmipserverupdatespec:90,kms_client:[0,1,52,103],know:16,knowledg:[2,52],knowledge_bas:2,known:[1,20,46,47,51,52,63,80,83,84,92,97,100],ksy:23,kube_api_server_opt:77,kubeapiserveropt:77,kubeapiserversecur:77,kubeconfig:52,kubectl:[52,77],kubernet:[52,64,77,78,80],kubernetes_content_librari:77,kubernetes_statu:[52,77],kubernetes_status_messag:52,kubernetesstatu:[52,77],l3:77,l4:52,l:[17,46,52],label:[1,2,23,52,97,99],lack:1,lan:97,lanc:97,languag:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,49,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100],laps:[1,71],larg:[1,47,52,77,78,97,98],larger:[1,24,31,52,78],last:[1,2,15,20,21,23,24,25,26,28,31,52,53,65,75,77,92,98],last_access:98,last_accessed_tim:1,last_attested_tim:92,last_check:2,last_check_tim:75,last_modifi:[52,98],last_modified_tim:[1,15],last_password_chang:1,last_sync_tim:[1,15],last_transition_tim:[52,77],last_update_tim:20,last_upgraded_d:77,lastapplyresult:[25,28,43],lastcheck:2,lastcheckresult:[28,43],lastcomplianceresult:25,lastiterationstatu:[52,98],lastnam:52,lastoverridetim:28,lastprecheckresult:25,later:[14,20,52,81,91],latest:[1,2,8,15,20,23,24,25,26,39,40,41,52,53,83,84,101],latest_query_tim:1,latest_recommend:[24,41],latestprivilegecheck:53,latter:12,launch:[24,41],lax:52,layer:46,layout:77,lazili:1,lcm:[0,1,52,103],lcm_client:[0,1,75,103],ld_library_path:97,ldap:[1,11,52],lead:[1,2,16,52,75,98],leaf:[52,54,91],leas:[1,16],least:[1,2,4,11,13,17,39,40,52,57,77,78,97,98],leav:[1,2,3,11,15,16,52,54,77],left:[1,13,15,20,23,31,43,52,97,98],legaci:[52,97],legibl:1,length:[1,2,4,11,16,24,47,52,54,77,98],less:[1,11,12,24,41,47,52,54,76,84,97,98],lesser:20,let:[24,41,52,77],letter:[2,4,11,52],level:[1,2,11,12,13,23,24,28,47,52,65,71,75,77,81,87,89,91,92],leverag:[2,80],lib:[15,97],librari:[0,1,15,18,47,52,77,89,101,103],library_cli:[0,1,16,103],library_id:[1,15,52],library_id_par:18,library_item:[16,52],library_item_content_vers:16,library_item_id:[15,16,52],library_items_cli:[0,1,52,103],libraryid:52,libraryitem:52,libraryitemid:52,librarymodel:[1,15,17,18],librarytyp:1,licens:[1,23,51,52,77,95],life:52,lifecycl:[1,11,16,20,23,38,52,64,65,77,97],lifecycledepot:23,lifecycleset:[23,24,27,33,34,35,36,37,38,39,40,41,42],lifecyclesoftwareremedi:[28,43],lifecyclesoftwarespecif:[20,22,23,24,29,41,44],lifetim:[1,11,16,52,74],like:[1,28,46,51,52,74,81],limit:[1,5,11,12,15,18,31,51,52,64,72,87,101],limitrang:52,line:[1,47,51,52,97],line_numb:52,link:[1,3,11,16,17,21,23,24,28,37,41,52,72,75,80,87,96,97,98],linklay:[3,11,98],linux:[1,14,52,97,98],linux_config:52,linuxconfigur:52,list:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,26,28,29,31,37,38,39,40,41,43,44,45,46,47,48,49,50,51,52,54,55,57,62,64,65,66,67,68,72,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,95,96,97,98,99,100,101],list_attachable_tag:14,list_attached_object:14,list_attached_objects_on_tag:14,list_attached_tag:14,list_attached_tags_on_object:14,list_detail:[2,52],list_opt:47,list_tags_for_categori:14,list_task:[87,90,91,92,93,95],list_used_categori:14,list_used_tag:14,list_v2:52,list_valu:47,listaccess:82,listeddriverfirmwarevers:28,listen:[2,11],listitem:[52,62,77],listresult:[1,52,62,75,77,98],liter:98,live:[2,20,52,66,101],load:[2,52,77,78,81,89],load_balanc:52,load_balancer_address_rang:78,load_balancer_config_spec:52,load_balancer_s:[52,78],loadbalanc:[52,78],loadbalancerconfig:52,loadbalancers:[52,78],loc_spec:[4,5],local:[1,2,3,4,11,15,16,20,21,24,26,46,47,51,52,54,72,77,78,89,97,98],local_account:1,local_accounts_cli:[0,1,103],local_accounts_polici:11,local_and_onlin:2,localaccount:[1,11],localaccounts_cli:[0,1,103],localaccountspolici:11,localfilesystem:97,localhost:2,localiz:[1,2,4,28,46,51,52,87],localizablemessag:[1,2,4,5,8,14,16,17,20,21,23,24,28,41,43,46,51,52,64,65,66,67,77,79,87,90,91,92,93,95,96,97,100],localizationparam:46,locallibrari:[1,15],locat:[1,2,4,5,11,15,16,17,20,21,23,24,41,51,52,64,66,75,77,96,97],location_password:[2,4,11],location_typ:[2,4],location_us:[2,4,5,11],locationpassword:[2,4],locationspec:[4,5,52],locationtyp:[2,4],locationus:[2,4],lock:[1,52],lockout:11,lockout_polici:11,lockoutpolici:11,log:[1,2,11,47,52,71,80,89,97],logarithm:1,logforward:11,logging_cli:[0,1,103],logic:[1,15,47,52,98,99],login:[1,2,4,11,46,47,52,77,97],login_bann:[52,77],logn:1,logon:52,logout:[2,47],logout_endpoint:52,long_dat:46,long_date_tim:46,long_opt:47,long_tim:46,long_valu:47,longer:[1,2,13,16,51,52,54,80,98],longhorn:52,look:[24,41,52],lookup:[1,2,52],lose:1,loss:[13,52,97],lost:[1,71],lot:47,low:[1,2,3,11,12,13,23,37,75],low_watermark:71,lower:[13,47],lowercas:[2,4,11,52],lowercase_char:11,lowest:13,lsi:99,lsilog:99,lsilogicsa:99,lun:[13,51],mac:[2,11,18,52,97,98],mac_address:[18,52,97,98],mac_typ:[52,97],macaddresstyp:[52,97],machin:[1,2,11,12,13,15,18,19,51,52,54,57,58,59,60,76,77,83,84,96,97,98,99,100,101],machineobject:52,made:[1,2,11,13,14,15,16,17,23,24,28,31,51,52,97,98,99,101],magic:23,mai:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,23,24,26,27,28,31,33,34,35,36,37,39,40,41,42,43,45,46,47,51,52,54,55,57,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,94,95,96,97,98,99,100,101,102],mail:11,mail_serv:11,main:47,maintain:1,mainten:[12,13,20,23,24,27,33,34,35,36,41,42,51,52,57,77,96],maintenance_mod:[12,13],maintenance_mode_requir:[20,24],maintenanceactiontyp:77,maintenancemod:26,maintenancemodest:12,major:[2,52,75,88],major_vers:88,make:[1,14,16,17,24,47,51,52,74,77,82,87,97,98,101],make_default:52,makedefault:52,malform:[45,51,52],manag:[0,1,2,3,4,8,9,10,11,12,13,14,15,16,20,23,24,26,27,28,29,30,31,32,34,35,36,38,39,41,42,43,44,46,47,52,54,55,63,64,65,66,67,71,73,74,77,78,80,81,83,86,87,88,89,90,91,92,93,95,96,97,98,99,101],manageclusterregistryresourc:64,managedobject:1,managekeyserv:66,management_cli:[0,1,52,77,80,103],management_network:52,management_network_nam:52,management_network_typ:52,management_resourcepool:11,management_vcenter_nam:52,management_vcenter_server_guid:52,managementclust:[8,11],managementcluster_cli:[2,7,8,9,10],managementdnsserversmiss:[52,77],managementnetworktyp:52,managementvirtualmachin:11,managementvmtyp:11,manageregistri:64,manageregistryproject:65,managers_cli:[0,1,20,23,103],managetrustedhost:87,mandatori:13,mandrak:52,mandriva:52,mandriva_64:52,mani:[47,51,52,88,89,98],manifest:[2,16,17,40,52],manipul:[1,2,16,96,97,99],manner:[20,23,28,43],manual:[1,2,3,5,11,13,15,52,75,96,97,98],manual_control:2,manual_failover_allow:52,manufactur:[20,52,88,89],manufacturer_certif:89,manufacturer_certificate_uri:89,manufacturercertif:89,map:[1,2,4,5,8,11,12,20,23,24,25,28,29,41,44,47,52,63,77,84,97],map_key_typ:47,map_value_typ:47,march:89,mark:[28,52,54,97],mark_as_verifi:31,marker:[52,53,98],markup:47,mask:[2,3,11,52,98],massachusett:[17,52],master:[77,90,97],master_dn:52,master_dns_nam:52,master_dns_search_domain:52,master_host:82,master_key_id:90,master_management_network:52,master_ntp_serv:52,master_storage_polici:52,master_vm_info:52,masterkeyid:90,matadata:38,match:[1,2,3,5,15,16,21,23,24,28,31,39,40,41,45,46,47,51,52,55,62,66,77,78,79,82,83,84,87,91,93,95,97,98],match_pattern:98,matrix:75,matter:1,max:[1,5,24,33,34,52],max_array_length:24,max_count:[4,11],max_dai:[2,11],max_days_between_password_chang:[1,11],max_failur:13,max_failure_window:13,max_host:[24,27,33,34],max_length:11,max_lif:11,max_result:5,max_string_length:24,max_valu:24,maxhost:[24,27,33,34],maximum:[1,2,11,12,13,16,24,27,33,34,52,64,71,77,97,98],maximum_concurrent_item_sync:1,maximum_instance_count:52,maximum_length:24,maximum_valu:24,maynot:75,mb:[1,2,4,11,12,18,52,76],mbp:1,md5:[16,52],mean:[1,2,5,11,14,15,16,23,28,31,39,40,46,51,52,55,62,75,78,79,98],meaning:[13,20,23,43],meant:[1,93],measur:[1,11,12],meatadata:1,mebi:1,mebibyt:[1,52,64,77,97],mechan:[3,11,45,46,47,51,52],med_dat:46,med_date_tim:46,med_tim:46,media:52,medium:[2,13,16,46,52,77,78],meet:[13,14,26],mega:1,megabyt:[1,2,4,13,18],mem:2,member:[1,11,15,20,23,51,52,63,64,65,77,87,90,91,92,95,101],membership:[19,51,52],memo:1,memo_:1,memori:[1,2,11,12,13,18,24,27,33,34,35,36,41,42,51,52,61,76,77,89,97],memory_alloc:[1,11,12],memory_capac:[52,77],memory_limit:52,memory_limit_default:52,memory_limit_default_unset:52,memory_limit_unset:52,memory_mb:[12,52],memory_request_default:52,memory_request_default_unset:52,memory_reserv:52,memory_size_mib:1,memory_upd:52,memory_us:[52,77],memoryinfo:52,memoryupdatespec:52,mention:[23,24,46,98],merg:[24,52],messag:[1,2,3,4,5,8,11,14,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,51,52,63,64,65,75,77,87,96,101],messagesever:[2,52,77],messagestatu:3,met:[13,52],meta:52,metadata:[0,1,2,14,15,17,20,23,24,38,41,46,51,52,92,102,103],metadata_bundl:38,metadata_cli:[0,1,102,103],metadata_vers:15,metadataidentifi:47,metadatainfo:[23,38],metamodel:[0,1,46,47,103],metamodel_cli:[0,1,46,49,103],meter:1,meterspersecond:1,meterspersecondsquar:1,method:[1,2,3,4,5,6,8,11,12,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],metric:1,metricunit:1,mhz:[1,11,12,13,18,52,76,77],mib:52,micro:1,microsoft:[11,52],mid:1,midnight:1,might:[1,2,8,11,12,13,16,24,45,47,51,52,57,59,77,93],migrat:[1,11,13,15,52,57,59,68,77,98],migrate_cli:[0,1,52,103],migrate_progress:52,migratespec:52,migration_threshold:[11,13],migrationassistantspec:52,militari:11,millennium:52,milli:1,millisecond:[47,97],min:1,min_array_length:24,min_dai:[2,11],min_days_between_password_chang:[1,11],min_length:11,min_string_length:24,min_up_tim:13,min_valu:24,min_vers:23,minim:[2,75,97],minimum:[1,2,11,23,24,28,52],minimum_instance_count:52,minimum_length:24,minimum_valu:24,minor:[2,52,75,88],minor_vers:88,minut:[1,2,4,11,13,16,20,23,51,52,64,75,97,98],minutes30:1,minutes5:1,mirror:[3,11,20,52],misc:[23,37],mismatch:[17,52],miss:[1,17,20,24,45,52,80,98],missing_fil:17,missing_instance_id:24,missing_requir:24,missing_required_profile_inst:24,missing_required_profile_kei:24,mitig:[2,47,75],mix:54,mixtur:99,mjr:52,mm:[11,46],mnr:52,mo_id:11,mode:[1,3,6,11,12,13,20,23,24,27,33,34,35,36,41,42,51,52,57,72,77,78,96,97,99],mode_get_op:52,mode_set_op:52,model:[1,11,20,21,28,31,46,47,49,52,88],model_compat:21,model_nam:20,moder:[2,13,23,37,75],modif:[1,16,24,52,97],modifi:[1,4,14,15,16,17,23,24,26,47,51,52,54,75,87,97,98,99],modificationinfo:24,modified_properti:24,modified_tim:[24,26],modifycustspec:52,modul:[0,7,85,102,103],moid:[1,21],mole:1,moment:52,mon:[1,46],mondai:[2,4,11,23,64],monitor:[1,2,13,47,51,52,71,96,97],monitoreditem:1,monitoreditemdata:1,monitoreditemdatarequest:1,monitoring_cli:[0,1,103],month:[1,23,24],monthli:23,monthly_by_dai:23,more:[1,2,3,4,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,49,51,52,63,64,75,77,78,79,83,84,89,90,93,96,97,98,99,100],most:[1,5,16,17,23,24,25,28,41,43,47,52,53,77,84,97,98,100,101],mostli:47,mount:[15,52,97],move:[1,15,17,51,52,77,98],ms:[11,52],msb:98,msg_protocol:46,msi:52,much:[20,23,28],multi:80,multipl:[1,2,3,4,5,8,11,14,15,16,18,20,21,24,28,29,44,45,47,52,55,62,63,77,95,97,98,99,100],multiple_host_access:[1,12],multipli:[1,52],must:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,37,38,39,40,41,42,43,44,45,46,47,48,49,50,52,54,55,57,59,60,61,62,63,64,65,66,67,71,74,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],mutabl:24,mutat:[87,95],mute:28,mutual:[1,23,28,43],mylibrari:15,myvmwareid:11,n:[1,2,51,98],n_a:52,n_a_token_method_typ:52,name:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,72,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],name_kei:[2,52],namespac:[0,1,46,47,52,64,65,77,78,79,80,81,103],namespace_manag:[0,1,52,64,103],namespace_management_cli:[0,1,77,103],namespace_network:52,namespace_network_cidr:52,namespace_subnet_prefix:[52,81],namespaceinst:64,namespaceresourceopt:52,namespaces_cli:[0,1,103],namespaces_licens:52,namespaces_support:52,namespaceselfservic:52,namespacesubnetprefix:52,namespacetempl:52,nano:1,nat:78,nate:52,nativ:[46,52,66,67,77],native_info:[66,67],native_spec:66,nativeprovidercreatespec:66,nativeproviderinfo:[66,67],nativeproviderupdatespec:66,natur:1,ncp_cluster_network_info:52,ncp_cluster_network_spec:52,ncpclusternetworkenablespec:52,ncpclusternetworkinfo:52,ncpclusternetworksetspec:52,ncpclusternetworkupdatespec:52,necessari:[1,16,17,25,46,52,61,83,87,92,95,97,100],necessarili:28,nedw:2,need:[1,2,13,14,15,16,17,20,21,23,24,26,33,43,46,47,51,52,54,55,57,59,60,61,63,65,66,74,75,77,97,98],neg:97,negoti:1,neither:100,nest:[1,2,4,46,77],nestedlocalizablemessag:46,net:[1,3,11,52],net_bios_mod:52,netbio:52,netbiosmod:52,netboot:97,netmask:[3,11,52],netwar:52,netware_4:52,netware_5:52,netware_6:52,network:[0,1,2,11,12,13,15,18,28,51,52,54,77,80,95,96,97,98,103],network_cli:[7,8,9,10,11,97],network_fold:1,network_list:52,network_loc:97,network_map:52,network_nam:[18,97],network_protocol:97,network_provid:52,network_serv:97,network_typ:81,networkaddress:[52,87,90,95],networkback:81,networkbackingenum:81,networkbackingtyp:52,networkcreatespec:52,networkd:1,networking_cli:[0,1,52,97,103],networkprotocol:97,networkprovid:52,networks_cli:[0,1,52,78,81,103],networksect:52,networkspec:52,networktyp:[52,81],never:[1,3,11,24,41,51,52,97,99],new_path:98,new_siz:2,new_subscribed_librari:15,new_vmdk:97,newer:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,22,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102],newer_compatibility_releas:21,newli:[1,8,15,52,65,74,75,87,97,99],newlin:16,newtwork:1,newvmdk:97,next:[1,13,23,52,65,97,98],nf:[1,2,4,12,15],nfs41:1,nfsv3:15,nfsv4:15,nginx:77,nic0:[1,2,3,11],nic1:[2,11],nic:[1,3,18,20,51,52,96,97,98,99],nics_to_upd:1,nistp:89,nld_9:52,nmumber:[11,12],no_authent:46,no_disk_spac:98,no_firmware_provid:28,no_impact:[8,20,24],no_proxy_config:[52,81],no_reboot:52,no_rx_loss:97,noaction:77,node1:52,node2:52,node:[1,2,4,5,8,15,20,22,23,27,28,34,47,51,52,77,78,90,96,97],nodeinfo:52,noderol:52,noderuntimeinfo:52,nodesin:52,nodest:52,nodevminfo:52,non:[1,2,8,11,12,14,15,16,20,23,24,28,31,52,54,69,82,97,98],non_complaint:24,non_compli:[8,20,24,83,84,100],non_compliant_data_processing_unit:20,non_compliant_host:[20,24],noncompli:28,noncompliance_mut:28,none:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],noproxi:2,nor:[1,100],normal:[1,11,12,15,66,67,77,87,90,98],not_a_directori:98,not_a_fil:98,not_allowed_in_current_st:[26,51],not_appli:[24,41],not_applic:[17,55,83,84,100],not_avail:16,not_certifi:[20,28],not_compli:[24,55],not_connect:97,not_elig:26,not_found:51,not_host_specif:24,not_initi:52,not_instal:52,not_respond:1,not_run:[52,97],not_stag:20,not_start:26,not_yet_valid_certif:[17,52],notallowedincurrentst:[1,2,3,4,8,15,16,17,20,21,23,24,26,41,51,52,63,65,68,69,75,77,96,97,98,99,101],notat:[12,52,97,98],notconfigur:52,note:[1,13,15,16,20,21,23,24,28,31,39,40,52,75,77,97,99],notfound:[1,2,3,4,5,8,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,37,38,39,40,41,42,43,44,47,48,49,50,51,52,54,55,61,63,64,65,66,67,71,74,75,77,80,83,87,88,89,90,91,92,93,94,95,96,97,98,99,101],noth:[2,97],notic:[15,28],notif:[1,2,8,11,20,21,23,24,26,28,41,43,52,75],notifi:[13,51],notsupport:52,noun:47,nov:52,novel:52,novemb:89,now:[16,23],ns:52,nsx:[0,1,52,77,78,81],nsx_advanc:78,nsx_client:[0,1,52,77,79,103],nsx_edge_clust:52,nsx_network:52,nsx_tier0_gatewai:52,nsxadvancedlbconfig:78,nsxconfig:78,nsxe:52,nsxedgeclust:[52,78,79],nsxnetwork:81,nsxnetworkcreatespec:52,nsxnetworkinfo:52,nsxnetworksetspec:52,nsxnetworkupdatespec:52,nsxroutingmod:78,nsxt:[52,81],nsxt_container_plugin:52,nsxt_vpc:52,nsxtier0gatewai:[52,78],nt:52,ntf:97,ntp:[1,2,11,52,77,78],ntp_client:[0,1,103],null_valu:24,num_cores_per_socket:52,num_cpu:[12,18,52],num_displai:18,num_supported_pod:52,num_supported_servic:52,number:[1,2,4,5,11,12,13,14,15,17,18,20,23,24,27,28,31,33,34,35,36,41,42,46,47,52,54,65,75,77,88,92,97,98,99,101],numer:[1,2,4,11,12,24,39,40],numeric_char:11,nvme:[1,97,99],nvme_adapt:1,nvmeadapt:[1,99],nvmeaddressinfo:97,nvmeaddressspec:97,o:[17,52],oauth2:[0,1,11,46,52,80,103],oauth2_client:[0,52,103],oauth2authenticationmethod:52,oauth2createspec:52,oauth2info:52,oauth2summari:52,oauth2updatespec:52,oauth:[1,45,46,52,80],oauth_access_token:46,oav:[3,11,52],obj_typ:77,object:[1,11,12,13,14,16,20,23,24,28,51,52,55,64,77,81,83,84,89,97,98,101],object_id:14,objectattach:63,objectcompli:[55,97],objectpubl:89,objecttotag:14,objtyp:77,observ:[52,77],obtain:[1,14,23,28,43,52,77,78,80,93,97,98],occur:[1,2,4,5,6,13,15,23,24,45,51,52,54,64,74,81,87,93,94,96,98],ocean:52,octal:98,octet:52,oe:52,oem:[20,23,24,28,29,37,39,41,44],off:[1,2,13,15,24,27,33,34,35,36,41,42,51,52,97,98,101],offer:[1,52,56,57,58,60],offici:[20,52,75],offlin:[23,38],offline_bundl:23,offline_cli:[0,1,20,23,103],often:[1,23,52,64],oid:54,oidc:[11,52,80],oidccreatespec:52,oidcinfo:52,oidcsummari:52,oidcupdatespec:52,ok:[2,4,13,20,23,24,28,43,52,66,67,87,90,91,92,95],ok_cancel:52,old:[1,11,52,98,101],old_password:1,old_siz:2,older:[2,11,20,52,102],oldest:[5,52],omit:[13,14,52,99],omit_from_snapshot_and_clon:52,omitfromsnapshotandclon:52,on_demand:[1,15],on_deploy:76,on_successful_upgrad:76,onc:[1,15,16,17,23,26,47,52,78,94,97,98],one:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,23,24,26,29,31,41,44,45,46,47,50,51,52,54,57,63,64,66,74,77,78,79,84,87,89,90,91,93,96,97,99,100,101,102],ones:[13,52,98],ongo:[16,52,77,87,95],onli:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,33,34,35,36,39,40,41,42,43,46,47,51,52,54,55,57,59,63,64,65,66,67,71,75,77,78,80,81,82,87,89,90,91,95,96,97,98,99,102],onlin:[2,20,23,38],online_cli:[0,1,20,23,103],ons:[20,23],onto:[1,15,52,101],onward:54,ooki:97,op:14,op_id:52,opaqu:[1,23,47,52,61,81,87,97],opaque_network:[1,52,97],opaque_network_id:97,opaque_network_typ:97,opaquenetwork:52,open:[1,11,52,97],open_ldap:11,open_vm_tool:52,openid:80,openserv:52,openserver_5:52,openserver_6:52,opensus:52,opensuse_64:52,oper:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,20,21,23,24,25,26,27,28,29,33,34,35,36,40,41,42,43,44,47,48,49,50,51,52,54,61,63,64,66,67,74,75,77,78,82,83,87,89,91,92,93,95,96,97,98,99,100,101],operation_detail:24,operation_id:[47,48,49,50],operation_not_found:51,operationdetail:24,operationinfo:[47,48,49,50],operationnotfound:51,operationresultinfo:47,operations_readi:97,operationtyp:24,operaton:24,operatorcli:74,opert:23,opid:52,optim:[1,15,97],optimist:[3,11,15],optimization_info:1,optimizationinfo:[1,15],optimize_remote_publish:15,option:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,22,23,24,26,27,28,31,33,34,35,36,41,42,43,46,47,51,52,64,65,66,67,71,75,77,78,81,87,89,90,91,93,95,97,98,99],optional_list:47,optioninfo:47,optionvalu:[12,13],optmiz:15,oracl:52,oracle_linux:52,oracle_linux_64:52,oracle_linux_6:52,oracle_linux_6_64:52,oracle_linux_7:52,oracle_linux_7_64:52,oracle_linux_8_64:52,oracle_linux_9_64:52,orang:[2,3],orchestr:52,order:[1,2,3,11,14,15,31,47,52,54,63,78,91,97,98,99],org:[52,77,80],org_id:52,organ:[24,47,52,54,80],organization_unit:54,organizationalunitnam:54,orgid:52,orglink:80,origin:[1,2,3,11,14,15,20,23,24,26,43,52,97,98],original_path:24,orphan:77,os2:52,os:[1,2,18,52,87,90,91,97,98],os_descript:18,os_typ:[18,52],osp:52,ostyp:52,other:[1,2,3,8,11,12,13,14,15,16,17,20,23,24,26,28,30,39,40,45,51,52,57,61,66,74,75,76,77,78,81,90,93,94,95,96,97,98],other_24x_linux:52,other_24x_linux_64:52,other_26x_linux:52,other_26x_linux_64:52,other_3x_linux:52,other_3x_linux_64:52,other_4x_linux:52,other_4x_linux_64:52,other_5x_linux:52,other_5x_linux_64:52,other_64:52,other_6x_linux:52,other_6x_linux_64:52,other_linux:52,other_linux_64:52,otherwis:[1,11,12,14,18,24,25,26,41,45,51,52,54,63,81,97,98],ou:[17,52,54],out:[1,8,15,20,23,24,28,43,47,51,52,54,78,81,83,84,95,97,98,99,100,101],out_of_d:[83,84,100],outbound:[2,11],outcom:[14,63],outer:89,output:[13,23,24,26,47,52,77,97],output_field:47,output_field_list:47,outputfieldinfo:47,outputinfo:47,outsid:[1,11,45,52,61,87,95],ova:[1,17],over:[1,11,13,15,16,28,52,57,77,96,97],overal:[1,2,3,8,20,24,28,31,52,64,77,100],overall_compli:100,overhead:16,overlap:[52,77,78],overload:[20,23],overrid:[11,12,13,20,23,24,26,28,31,52,77],overridden:[1,13,20,28,52],overridden_compon:20,overriden:23,overrun:97,overview:[80,97],overwrit:[3,23,29,44,51,52,94,98],overwritten:[24,52,93,97,98],ovf2:52,ovf:[0,1,15,16,17,18,52,103],ovf_client:[0,1,15,103],ovf_environ:52,ovf_library_item_id:52,ovf_strict_verif:1,ovferror:52,ovfinfo:52,ovfmessag:52,ovfparam:52,ovfsummari:52,ovftempl:18,ovfwarn:52,own:[15,21,46,51,52,74,77],owner:[8,23,24,41,45,52,97,98],owner_id:98,ownerdata:23,p:2,pacakg:[39,40],pack:97,packag:103,package_id:47,packageinfo:[40,47],packagemetadata:[52,77],packages_cli:[0,1,20,23,39],packet:[3,11,98],packetr:1,page:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102,103],pages:52,pagin:52,pair:[11,12,21,31,52,93],palo:[17,52,54],parallel:[1,24,27,33,34,41,97],parallel_port:1,parallel_ports_to_upd:1,parallel_remediation_act:[24,27,33,34],parallelport:[1,97],parallelremediationact:[24,27,33,34],param:[1,23,46,47,52,77,80,98],paramet:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],parameteriz:52,paravirtu:99,parent:[1,2,4,5,8,11,12,14,15,18,20,22,23,24,27,28,34,51,52,65,97,98],parent_fold:1,parent_id:24,parent_path:[11,12,98],parent_resource_pool:1,parentref:52,pars:[51,52],parse_error:52,parseissu:52,part:[1,2,4,5,11,14,15,17,20,21,23,24,26,28,29,31,41,47,51,52,87,89,93,97,98],part_numb:[28,31],parti:[23,39,40,46,52,54,77,94],partial:[1,14,20,52,63,96],partial_maintenance_mode_requir:20,partially_autom:[11,13],particip:15,particular:[1,2,3,8,11,13,15,19,20,23,28,39,40,43,46,47,51,52,55,75,77],partit:[1,2,97],partner:[28,52],partner_avail:52,partner_hostnam:52,pasrs:52,pass:[1,2,4,5,6,8,12,14,15,16,18,20,21,23,24,25,26,28,29,31,37,38,39,40,43,44,46,47,51,52,55,57,59,60,61,62,63,64,65,66,67,68,69,75,77,78,79,80,81,82,83,84,87,88,89,90,91,92,95,97,98,99,100,101,102],passiv:[52,96],passive_redeploy_op:52,passivespec:52,passthru:97,passthru_exclus:97,password:[1,2,4,11,15,20,23,46,47,51,52,66,68,78,81,93,97],password_expir:1,password_expires_at:1,password_polici:11,password_reus:11,passwordpolici:11,pasword:[1,11],patch:[2,11,21,24,41,52,75],path:[1,2,4,8,11,12,13,15,16,24,46,47,52,54,97,98],path_length_constraint:54,path_too_long:98,pattern:[1,24,98],pattern_mismatch:24,paus:[1,52],payload:[20,23,51,75],pci:[18,20,21,28,52,97,99],pci_address:20,pci_devic:20,pci_device_compli:28,pci_slot_numb:[18,97,99],pcidevic:[20,21,28],pcidevicecompli:28,pcidevicecomplianceinfo:28,pcideviceconstraint:28,pcislotnumb:52,pck:61,pcnet32:97,pcr:[88,89],pcr_digest:89,pcrbank:[88,89],pdl:13,pebi:1,peer:93,peform:1,pem:[1,52,54,78,80,81,89,91,93],pend:[1,2,14,24,52,65,75,77,97,98],pending_upd:75,per:[1,3,13,46,52,97],percent:[1,2],percentag:[4,13,52],perform:[1,2,3,4,5,8,11,12,14,15,16,17,20,23,24,25,26,28,40,41,43,51,52,66,68,69,74,77,78,82,87,95,96,97,98,99,101],performance_degradation_vm_toler:13,period:[1,11,12,13,16,23,24,52,54,71,97],perl:[52,98],perm:52,perman:[13,77],permanentremov:77,permen:13,permiss:[1,11,12,14,18,52,68,82,97,98],permit:[3,97],persist:[1,15,20,49,52,77,81],persist_json_en:[1,15],persistent_volume_claim_count:52,persistent_volume_claim_count_unset:52,persistentvolumeclaim:52,persistentvolumeclaimcount:52,person:[46,52],perspect:[51,52,97],pertain:[28,30,43,52],peta:1,phase:[1,28,75],photon:52,phrase:[46,47],physic:[28,51,52,97,99],pick:[1,20],pico:1,pid:[1,97],piec:[2,4,11,46,47],piko:1,pipe:97,pipe_cli:97,pipe_serv:97,pkc:54,pkg:[20,39,40],place:[1,12,13,15,52,83,84,97,100,101],placehold:[1,24],placeholder_found:24,placement:[1,11,13,15,52,55,56,57,58,96,101],placement_cli:[1,52,55,56,57],placementinfo:[15,52,96],placementspec:[1,52,96,101],plaftorm:24,plain:[2,52,77],plain_text:2,plan:52,plane:[52,77,78,81],platform:[1,11,22,23,24,26,52,54,61,80,88,89,91],pleas:[1,52],plu:97,plug:[51,52],plugin:[1,8,15,23,24,26,52,77],plural:46,pnid:[1,2,3,54],pod:[12,52,77,78],pod_cidr:52,pod_config:12,pod_count:52,pod_count_unset:52,pod_nam:77,pod_storage_drs_entri:12,podcidr:52,podcount:52,podidentifi:77,podstoragedrsentri:12,podvm:[52,77],point:[1,11,15,24,41,47,51,52,75,87,95,98],pointer:24,pointless:51,polici:[0,1,2,3,11,13,15,16,18,19,20,23,24,32,33,35,41,51,52,54,55,64,77,83,87,89,97,100,103],policies_cli:[0,1,20,23,27,32,34,52,97,103],policy_cli:[0,1,15,18,52,97,103],policy_pcr:89,policy_typ:13,policypcrspec:89,policytyp:97,poll:[47,97],polymorph:1,pool:[1,11,12,13,15,52,71,101],popul:[24,28,46,52,97,100],populateds:52,port:[1,2,3,11,15,20,23,46,51,52,70,77,78,81,87,90,97],portgroup:[1,52,97],portion:[24,51,97,98],posit:[1,12,46,52,98],posix:[97,98],posix_attribut:98,posixfileattributescreatespec:98,posixfileattributesinfo:98,posixfileattributesupdatespec:98,possibl:[1,2,4,8,11,12,13,15,17,20,21,23,24,26,27,28,30,31,33,34,35,36,37,41,42,43,46,47,51,52,63,75,77,81,87,89,90,96,97],possible_answ:52,possible_valu:24,post:52,postcustom:52,postgr:[2,4,5],potenti:[1,2,11,52],power:[1,11,13,24,27,33,34,35,36,41,42,51,52,57,97,98,99,101],power_manag:13,power_off:13,power_off_vm:[24,27,33,34,35,36,41,42],power_on:1,power_st:1,powered_off:[1,52],powered_on:[1,52,101],poweredg:20,powermanag:13,poweroff:[1,13,52],poweron:[1,52],powerst:[1,97],pr1459646:97,pr1459647:97,pre:[1,11,12,24,26,52,74,75,77,96],pre_check:24,pre_remediation_power_act:[24,27,33,34,35,36,41,42],preced:51,precehck:75,precheck:[2,4,8,23,24,25,52,75,77],precheck_result:24,precheck_task:[23,24,26],precheckreport:75,precheckresult:[2,23,24],prechek:8,precis:[46,47],precondit:1,precustom:52,predefin:[1,11,12],predic:1,predict:13,prefer:[1,3,11,13,15,52,97,98],prefix:[3,11,39,40,52,77,97,98],prefix_length:98,prefixlength:98,prem:52,prepar:[17,52],prepare_request:17,preparestatu:17,prepend:97,preremediationpoweract:[24,27,33,34,35,36,41,42],prerequisit:[1,52,77],present:[1,2,11,12,15,16,20,21,23,24,28,37,40,41,46,47,51,52,54,63,75,77,78,87,90,91,92,95,97,98],preserv:[47,98],preserve_mac:52,press:51,prevent:[1,2,13,24,27,33,34,51,52,54,97],preview:[1,8,11,16,17,57,59,86],preview_info:16,previewinfo:[16,17],previewwarninginfo:17,previou:[2,11,52,75,101],previous:[1,23,24,30,41,47,51,52],primari:[47,51,52,54,77,97],primarili:[1,77],primit:[24,47],primitive_valu:47,primitivevalu:47,princip:[11,12,52,82,87],principl:52,print:[47,102],prior:[1,51,52,77],priorit:1,prioriti:[2,13,78],privaci:98,privat:[1,23,46,52,54,65,77,89,93],private_area:89,private_kei:[54,93],private_key_jwt:52,priveleg:[52,83,97],privileg:[0,1,11,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,51,52,53,54,55,62,63,64,65,66,67,71,74,77,78,79,80,82,83,84,87,88,89,95,96,97,98,99,100,101,103],privilege_check:52,privilege_checks_cli:[0,1,52,103],privilege_cli:[0,1,46,50,103],privilege_id:11,privilege_info:47,privilegecheck:52,privilegeinfo:47,proactive_drs_en:13,proactive_ha:12,proactivedr:13,proactivehaconfig:[12,13],probe:1,proberesult:1,probesubscript:1,problem:[1,2,13,51,52,96],proce:[2,4,77,91],procedur:52,process:[1,2,3,4,11,15,16,17,20,26,51,52,75,83,97],processerrordetail:97,processor:[52,97],produc:[1,20,52],product:[1,2,5,8,11,28,31,52,57,59,75],product_kei:52,product_nam:75,product_select:31,productcatalog:75,productsect:52,productselectionspec:31,profession:52,profil:[2,8,24,52,77,83,84,87,100],profile_nam:[52,77],profile_ori:24,profile_spec:2,profileinfo:2,profilespec:2,profilesspec:2,progess:77,program:[1,11,20,21,51,52,78,97,102],progress:[1,2,4,5,8,14,16,20,23,24,26,28,41,43,51,52,61,75,77,88,89,98],project:[1,52,64,65,87],propag:[2,11,12,14,18],proper:[1,46,52],properli:[2,52],properti:[1,2,8,11,12,13,15,16,17,23,24,52,55,57,59,60,77,98,99],property_nam:24,property_name_mismatch:24,property_path:[24,47],propertyparam:52,propertypath:47,proportion:[1,11,12],propos:13,protect:[13,74],protocol:[2,3,11,46,51,52,78,89,90,91,97,98],prototyp:52,provid:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,95,96,97,98,99,100,101,102],providers_cli:[0,1,52,87,90],provis:[1,16,52,77,93,97],proxi:[2,11,52,81,90,97],proxy_configur:11,proxy_serv:90,proxy_settings_sourc:[52,81],proxyconfigur:[11,52,81],proxysettingssourc:[52,81],psc:[52,68,69,70],psc_client:[0,1,52,68,103],psc_extern:52,psc_hostnam:52,pscregistr:52,pscspec:52,public_area:89,public_kei:[89,91],public_key_uri:52,publicli:[15,78],publish:[1,15,23,78],publish_info:1,publish_url:15,publishinfo:[1,15],publishlibrari:1,publishlibraryitem:15,pull:[16,17,23,24,41,52,77,81],pullloc:[24,41],pure:52,purg:[65,101],purpos:[1,41,47,51,52],push:[16,17,23,24,41],put:[1,2,11,17,23,24,26,47,51,52,57,95,98],pvscsi:99,pxe:97,python:52,qualif:52,qualifi:[1,3,47,52,89],qualified_nam:89,quarantin:13,quarantine_mod:13,quarter:1,quer:97,queri:[1,2,3,8,11,14,15,16,20,21,23,24,28,40,41,49,52,55,62,63,71,75,77,81,84,87,97,98,101],query_data_point:1,query_opt:1,querycap:1,querydatapoint:1,querypred:1,question:[2,52],question_id:52,question_rais:52,questiontyp:52,queue:51,quick:[24,27,33,34,35,36,41,42],quit:47,quorum:52,quot:61,quota:[52,64],r2:52,r740xd:20,rais:[1,2,3,4,5,6,8,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,47,48,49,50,52,53,54,55,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],ram:18,random:[3,11,23,98],randomli:[3,11],rang:[1,23,51,52,77,78,97,98],rare:1,rate:[1,2,4,11,13,75],rather:[1,13,17,52,91,97],raw:[1,52,97],rdma:[28,31],re:[17,23,52,77,100],reacabl:3,reach:[1,8,17,20,23,24,52,64,65,77],reachabl:[1,2,3,11,52,68,69,81,98],react:[13,51,52],read:[1,3,6,14,15,16,20,21,22,23,24,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44,47,51,52,54,55,62,63,64,65,71,74,77,78,79,80,87,88,89,96,97,98,99,101],read_onli:[52,98],read_writ:52,readabl:[1,15,20,22,23,28,37,40,43,45,46,52,77,78,79],readcustspec:52,readi:[13,16,17,52,65,77,97,98],readkeyserversinfo:[66,67],readstorag:[16,17],readstsinfo:52,readthedoc:52,readtrustedhost:[52,87,95],readwritemani:[52,77],real:1,realiz:52,realli:51,realm:51,rearrang:28,reason:[1,13,17,47,51,52,54,63,77,79,98,101],reboot:[1,2,6,8,20,23,24,26,52,75,97],reboot_requir:[2,8,20,24,75],rebootopt:52,rebuild:77,recal:[23,37],recall_fix:[23,37],receiv:[1,13,16,17,51,52,71,78,102],recent:[1,5,23,24,25,28,41,43,52,53,61,97,100],recenttask:25,reclaim:65,reclassif:31,reclassificationspec:31,recogn:[1,20,51,52],recogniz:28,recommend:[1,2,8,11,13,15,24,41,52,57,59,78,97,101],reconcil:52,reconcili:4,reconciliation_cli:[0,1,2,103],reconfigur:[1,13,52,97],reconfigurespec:52,reconnect:1,record:[1,23,24,52,53,71,75,77],recov:[1,13],recover:97,recoverable_error:97,recoveri:[0,1,2,11,103],recovery_cli:[0,1,103],recurr:[4,11,23,64],recurrence_info:[4,11],recurrenceinfo:[4,11],recurs:[46,98],red:[2,3,13,52],redeploi:[52,96],redeploy_task:96,redeployspec:96,redhat:52,redirect:[45,52,75,97],reduct:13,refer:[1,4,5,13,15,16,18,19,21,24,26,46,47,52,77,78,79,87,95,98],referenc:[1,13,15,16,17,20,22,23,24,25,26,27,28,29,30,41,42,43,44,52,62,63,67,71,78,81,87,88,89,95,97,98,101],referencehost:26,reflect:[1,12,20,47,52],refresh:[1,3,12,23,45,52,54],refresh_token:[1,52],refresh_token_typ:[1,52],refreshtoken:11,regain:97,regard:[20,23,24,37,40,41,66,67,87,90,91,92,95,98],regardless:39,regexp:2,region:[52,61],regist:[1,2,20,23,24,41,47,51,52,61,64,68,75,80,87,91,95],register_task:61,registerplacementspec:1,registerspec:[1,61],registr:[46,52,61],registration_accept:52,registri:[0,1,52,64,77,103],registries_cli:[0,1,52,103],registrynam:77,registrypassword:77,registryusernam:77,regular:98,reject:[1,2,3,11,77,91,97],rel:[1,11,12,15,98],relai:11,relat:[1,2,4,12,14,15,23,24,25,37,52,77,80,83,84,91,96,97],relay_port:11,releas:[1,2,15,20,21,23,28,31,37,39,40,52,75],release_d:[2,20,23,37,52,75],release_not:[52,75],released:2,releaseinfo:75,relev:[1,2,3,4,5,8,14,15,16,17,20,23,24,26,27,28,33,34,35,36,41,42,43,46,47,52,64,65,66,67,71,77,78,81,87,90,95,97,98,99],reli:[1,80,97],relinquish:97,reload:1,reloc:1,relocate_task:1,relocateplacementspec:1,relocatespec:[1,52],relp:11,remain:[1,15,24,31,47,52,59,66,77,80,83,84,90,91,96,100],remaind:[39,40],remaining_retri:24,remedi:[13,20,23,24,26,27,33,34,35,36,41,42,52,87,95],remediation_not:24,remediation_summari:24,remediationtyp:13,remot:[1,2,5,11,15,16,46,52,61,68,69,70,90,91,93,97,98,102],remote_addr:46,remote_psc:52,remote_psc_cli:[0,1,52,68,69],remotepsc:68,remotepscspec:[52,68],remotespec:70,remov:[1,2,13,14,15,16,17,23,29,31,37,40,44,51,52,63,65,66,72,75,77,80,87,90,91,92,95,97,98,99],remove_from_used_bi:14,removed_compon:[37,40],removedcomponentinfo:[37,40],renam:98,render:[18,46,52],render_typ:18,renew:[1,11,54],repeat:[45,52],repeatedli:94,replac:[1,3,11,15,20,23,24,29,52,54,77,80,93,97,98],replace_vmca_sign:54,replacespec:54,replai:89,replic:[51,52,69,90,96],replica:52,replica_set_count:52,replica_set_count_unset:52,replicaset:52,replicasetcount:52,replicatedpscspec:[52,69],replicatedspec:52,replication_controller_count:52,replication_controller_count_unset:52,replication_partn:52,replicationcontrol:52,replicationcontrollercount:52,replicationstatu:52,repoint:52,report:[1,2,4,8,14,15,16,20,21,23,24,28,41,43,45,46,47,51,52,64,65,72,75,77,78,79,80,82,83,84,87,95,97,98,99,100,101],report_token:20,reportrow:75,reports_cli:[0,1,20,23,24,30,31,41],reportsummari:75,repositori:[1,2,11,52,64,65,77],repres:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,54,55,64,65,66,67,71,75,76,77,78,80,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102],represent:[1,2,17,20,52],request:[1,2,4,8,15,16,17,20,21,23,24,25,28,43,45,46,47,51,52,54,64,65,66,72,74,77,78,79,80,82,83,84,88,89,93,94,96,97,98,99,100,101],requested_token_typ:52,requir:[1,2,4,8,11,13,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,51,52,53,54,55,59,62,63,64,65,66,67,69,71,74,77,78,80,83,84,87,88,89,90,91,92,95,96,97,98,99,100,101],require_certificate_valid:91,require_endorsement_kei:91,required_free_disk_space_on_sourc:52,required_properti:24,required_valu:24,requisit:26,reserv:[1,11,12,13,18,24,27,33,34,35,36,41,42,52,75,76,81],reset:[1,11,13,23,31,51,52,97],reset_groups_claim:52,reset_upn_claim:52,resid:[14,16,20,99],resiz:2,resize_ex:2,resolut:[1,2,8,20,23,28,30,43,52,78],resolv:[1,13,20,23,52,70,78,97],resourc:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,55,57,59,60,61,62,63,64,65,66,67,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],resource_address_schema:1,resource_busi:51,resource_cli:[0,1,46,47,103],resource_config:11,resource_id:[1,47,49,52],resource_in_us:51,resource_inaccess:51,resource_not_found:1,resource_pool:[1,12,15,52,101],resource_pool_id:52,resource_spec:52,resource_typ:[1,15,16,23,24,29,41,44,47,48,49,50,52,55,66,75,87,88,89,90,91,92,97,99,101],resourceaddress:1,resourceaddressschema:1,resourceallocationcreatespec:1,resourceallocationinfo:[1,11,12,76],resourceallocationupdatespec:1,resourcebusi:[1,3,16,51,52,61,87,95,97,98,99,101],resourceconfigspec:11,resourceiddefinit:1,resourceinaccess:[1,15,20,21,51,52,87,97,99,101],resourceinus:[1,23,51,52,97,98,99],resourcepool:[1,11,12,15,52,101],resourcepool_cli:[7,8,9,10,11],resourcepooldeploymentspec:52,resourcepoolsummari:12,resourcequotaoptionsv1:52,resourcequotaoptionsv1upd:52,resourcespec:52,resourcetyp:1,respect:[1,8,20,28,52,87,95,99],respond:[1,8,13,15,16,51,52,64,65,72,77,78,79,80,82,83,84,97,98,99,100,101],respons:[1,8,13,17,20,21,23,24,28,41,47,51,52,74,75,77,87,98,102],response_delai:13,response_recoveri:13,rest:[1,13,46,51,52,91,92],restart:[1,2,8,13,52,54],restart_aggress:13,restart_conserv:13,restart_priority_condition_timeout:13,restart_servic:8,restartprior:13,restor:[1,2,4,15,17,52],restore_cli:[0,1,2,103],restorejobstatu:4,restorerequest:[2,4],restrict:[2,3,11,14,21,52,66],resubmit:51,result:[1,2,3,4,5,8,11,14,15,16,17,20,21,23,24,25,26,28,30,31,39,40,41,43,47,51,52,55,62,63,64,66,67,71,75,77,78,80,82,83,84,88,89,93,94,95,98,101],result_spec:1,resultinfo:52,resum:52,retain:[4,11,47,52,97,101],retent:[4,11],retention_info:[4,11],retentioninfo:[4,11],retreiv:[2,47],retri:[20,23,24,27,28,33,34,35,36,41,42,52,97],retriabl:20,retriev:[1,2,13,14,16,17,23,24,28,30,37,40,41,46,47,48,49,50,51,52,54,55,64,66,67,71,75,77,78,79,87,89,93,96,97,98,100],retriv:24,retry_count:[24,27,33,34,35,36,41,42],retry_delai:[24,27,33,34,35,36,41,42,97],retry_pend:[23,24,28],retrycount:[27,34,36,42],retrydelai:[27,34,36,42],return_al:1,returnresult:[2,4],returnstatu:[2,4],reus:[1,11],rev:52,revers:52,revert:[2,52],review:[17,21,52,93],revis:[24,52,89],revok:[14,45,52],revoke_propagating_permiss:14,rfc1123:52,rfc3986:52,rfc6749:52,rfc7235:51,rfc8414:80,rfc8693:52,rfc:[1,3,11,47,52,74,97,98],rhel_2:52,rhel_3:52,rhel_3_64:52,rhel_4:52,rhel_4_64:52,rhel_5:52,rhel_5_64:52,rhel_6:52,rhel_6_64:52,rhel_7:52,rhel_7_64:52,rhel_8_64:52,rhel_9_64:52,rhttpproxi:54,rich:18,rid:1,right:[24,27,33,34,35,36,41,42,52,75,97],risk:[2,11],robo:23,rocki:52,rockylinux_64:52,role:[1,11,12,52,77],role_id:[11,12],role_nam:11,roll:[15,52],rollback:[1,2,15,52,101],rollback_in_progress:1,rollbackspec:101,rom:[1,52,97,99],root:[1,11,12,18,52,54,61,80,81,91],root_account_polici:11,root_cert:54,root_password:52,rotat:52,rotate_password:52,rough:[2,75],rout:[51,52,78,98],routabl:77,routed_mod:52,router:[78,98],routing_cli:[0,1,46,103],routing_mod:78,rp:52,rpc:51,rpm:52,rs256:46,rsa:89,rsa_2048:89,rsrc:1,rsrc_addr:1,rsrcaddr:1,rsrcaddrschema:1,rsrcid:1,rsrctype:1,rule:[1,2,3,11,12,13,97],run:[1,2,3,4,5,8,11,12,13,14,20,23,24,25,26,28,43,51,52,59,61,63,64,75,76,77,81,87,96,97,98,101],run_stat:52,running_in_progress:1,runstat:[52,97],runtim:[46,52,77,97,99],rx:1,s:[1,2,11,12,13,14,15,16,17,20,21,23,24,26,28,29,30,39,40,41,46,47,51,52,61,63,64,66,74,77,80,81,82,87,89,90,93,95,96,97,98,99,100,101,102],sa:[28,99],sai:[14,24,41,51],said:[20,47,48,50,52,66],same:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,49,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],saml1:52,saml1_token_typ:52,saml2:[1,52],saml2_token_typ:[1,52],saml:[1,46,47,51,52,97],saml_bearer_token:[46,97],saml_hok_token:[46,47],saml_token:97,samltoken:46,sampl:[1,46,77],sampletyp:1,san:1,saniti:52,sata:[1,18,28,97,99],sata_adapt:1,sataadapt:[1,99],sataaddressinfo:97,sataaddressspec:97,satisfi:[13,52,62,69,97],saturdai:[2,4,11,23,64],save:[1,23,101],scalabl:13,scalable_shar:13,scale:[1,13,52,57],scale_cpu_and_memory_shar:13,scaleoutgroup:52,scaleoutparam:52,scaleoutsect:52,scalesharesbehavior:13,scan:[8,20,23,24,28,30,41],scan_desired_state_task:8,scan_task:[8,23,24,41],scan_tim:[20,28],scanresult:8,scanspec:8,scantim:28,scenario:[1,2,15,17,52,54,75],schedul:[1,2,4,5,11,16,23,28,51,52,64,65],schedule_id:11,schema:[1,23,24,26,52],schema_not_found:24,schemaresult:[24,26],schemavalidationerror:24,scheme:[1,16,17,23,24,41,46,47,48,51,52,80],scheme_typ:47,schemeid:46,schemetyp:47,scim2_0:52,scim:52,sco:52,scope:[1,45,49,52,65,80],scp:[2,4],script:52,script_text:52,scsi:[1,18,51,97,99],scsi_adapt:1,scsiadapt:[1,99],scsiaddressinfo:[97,99],scsiaddressspec:97,sddc:52,sdk:[1,52,97,102],seal:[88,89],search:[1,2,3,11,15,52,77,78,92,97,103],search_domain:[78,97],searchabl:14,second:[1,2,3,5,11,13,24,27,33,34,35,36,41,42,52,71,74,90,96,98],secondari:[51,52,97],seconds_since_epoch:2,secret:[47,52,80,89],secret_count:52,secret_count_unset:52,secretcount:52,section:[23,24,51,52,89],section_restrict:52,section_unknown:52,secur:[1,2,11,15,16,23,37,46,47,51,52,61,74,75,77,78,87,98],security_cli:[0,1,2,103],security_compli:15,security_policy_id:1,securitycontext:46,securitypolici:1,securityruletyp:1,see:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,23,24,26,27,28,31,33,34,35,36,37,39,41,42,43,45,46,47,51,52,55,57,59,60,62,63,64,65,66,67,71,75,76,77,78,81,82,83,84,87,89,90,91,92,93,95,96,97,98,99,100,102],seed:89,segment:[47,52,81],select:[1,4,20,24,28,30,31,39,40,47,52,75,77,78,81,89],selected_by_default:4,selected_kei:52,self:[1,17,51,52,93,96],self_service_namespac:52,self_sign:17,self_signed_certif:[17,52],selfservicemanag:52,semant:[1,24,77],send:[1,2,3,11,71,91,98,102],send_test_messag:2,sensit:[1,47,52],sent:[1,2,23,46,51,71,77,80,97,98],sentenc:47,separ:[1,3,11,21,47,52,97,98],sequenc:[1,47,51,77,99],seri:[20,21,24,28,41,52,77],serial:[1,52,97],serial_numb:54,serial_port:1,serial_ports_to_upd:1,serialnumb:54,serialport:[1,97],seriou:2,serv:[1,15,16,51,52,78,96,97],server:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,31,33,34,35,36,37,41,42,43,45,46,47,51,52,54,55,57,59,60,63,64,65,66,67,68,69,71,74,75,76,77,78,81,83,84,87,89,90,91,92,93,94,95,96,97,98,99,100,102],server_endpoint:52,server_guid:[1,15],server_hcl:21,server_nam:93,server_reach:[1,2],server_trust_cli:90,server_unreach:[1,2],servercompat:21,serverhclinfo:21,serverinfo:90,serverstatu:[1,2],servic:[1,2,4,5,8,11,12,13,14,15,16,17,20,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,48,49,50,51,52,54,60,64,71,72,74,77,78,80,81,83,84,87,89,90,91,93,94,95,97,99,100,102],service_cidr:52,service_cli:[0,1,46,47,52,77,103],service_config:77,service_count:52,service_count_unset:52,service_id:[47,48,49,50],service_namespac:77,service_provider_ent:11,service_unavail:51,servicecidr:52,serviceconfig:77,servicecount:52,serviceinfo:[2,47],serviceproviderent:11,services_cli:[0,1,103],services_will_be_stop:2,servicesappliedconfig:[87,95],servicest:13,servicestatu:90,serviceunavail:[1,2,8,20,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44,51,52,71,83,84,88,89,97,98,99,100],session:[1,2,12,16,17,20,24,46,47,51,52,53,89,97],session_awar:47,session_id:[46,47],session_manag:47,sessionid:46,sessionless:47,set:[0,1,2,3,4,5,6,7,14,15,16,17,18,20,21,22,45,46,47,49,51,52,54,55,57,62,63,64,66,67,72,75,77,78,80,81,82,83,84,87,88,89,90,91,92,93,95,97,98,99,100,103],set_id:1,set_task:[24,41,93,96],setid:1,setspec:[23,52,54,77,80,97],settabl:52,settingcompli:24,settings_cli:[0,1,23,24,26,28,29,41,43,44,103],settings_daemon:24,settingspec:1,setup:[28,52,97],sever:[2,14,21,46,52,75,77],severitytyp:75,sftp:[2,4],sgx:61,sgx_client:[0,1,52,103],sh:[52,97],sha1:[1,16,20,23,52,70],sha256:[1,16,89],sha384:89,sha512:[16,89],sha:[1,15,16,20,52,89],shall:[13,23,24,52,77],share:[1,11,12,13,15,18,52,57,59,60,99],sharesinfo:1,she:51,shell:[2,11,52,97],shellconfig:2,ship:46,short_dat:46,short_date_tim:46,short_datetim:46,short_messag:16,short_opt:47,short_tim:46,shorter:[16,87],shoud:97,shoudl:2,should:[1,2,3,4,5,11,13,14,15,16,17,20,21,23,24,26,27,28,33,34,35,36,39,40,41,42,46,47,51,52,54,55,63,64,65,68,77,78,79,81,82,83,84,90,91,93,96,97,98,99,100,101],shouldn:[1,23],show:[15,17,20,21,23,24,28],show_chang:24,showchang:24,shown:[2,98],shrink:14,shut:[13,97],shutdown:[1,2,13,52,97],shutdown_cli:[0,1,103],shutdown_tim:1,shutdownconfig:1,shutdowntim:1,shutting_down:97,side:[1,16,17,98],sigkil:97,sign:[1,15,16,17,46,47,51,52,54,77,87,89,91,93,94],signal:97,signatur:[46,52,54,77],signature_algorithm:54,signific:[2,75,98],significantli:[2,75],signing_cert_chain:54,signingcertif:54,sigterm:97,silver:20,similar:[47,52],similarli:[14,52,91],simpl:[47,97],simpli:52,sinc:[1,2,5,8,11,17,23,24,28,47,51,52,57,59,64,65,97,99,100,102],singl:[1,2,3,11,14,15,16,20,23,24,27,33,34,41,46,47,52,63,77,80,97],site:52,sitenam:52,situat:1,situt:51,six:1,six_month:24,size:[1,2,4,5,11,12,13,15,16,17,18,51,52,54,77,78,81,97,98],size_hint:52,size_mib:[52,97],sizemib:97,sizeparam:52,sizinghint:[52,77],sjd:52,skip:[8,11,12,13,23,24,28,41,43,52],skip_software_check:[24,41],skipped_host:[23,24,28],skylak:20,slaac:[3,11],slave:97,sle:52,sles_10:52,sles_10_64:52,sles_11:52,sles_11_64:52,sles_12:52,sles_12_64:52,sles_15_64:52,sles_16_64:52,sles_64:52,slot:[13,18,52],slow:[2,4],sm3:89,sm3_256:89,small:[52,77,78],smaller:[24,31],smb:[2,4,15],smbio:[1,52],smtp:11,snapshot:[2,17,51,52],snat:[52,78],so:[1,2,14,15,17,23,24,39,40,46,47,51,52,54,65,77,81],soap:[51,52,101],socket:[52,97],sofia:52,soft:97,softwar:[0,1,2,8,20,22,23,24,26,27,32,33,34,35,36,38,41,42,52,61,75,77,78,92],software_cli:[0,1,20,23,28,43,52,103],software_commit:[23,24],software_info:20,software_spec:[23,24,41],software_specification_exist:[24,41],software_specification_not_set:26,software_update_polici:11,softwareinfo:[20,23,24,41],softwarepackag:2,softwarespec:[20,23],softwareupdatepolici:11,solari:[52,97,98],solaris_10:52,solaris_10_64:52,solaris_11_64:52,solaris_6:52,solaris_7:52,solaris_8:52,solaris_9:52,sole:[77,97],solici:52,solut:[1,20,23,24,28,41,52,87],solutioncompli:20,solutioncomponentdetail:20,solutioncomponentspec:20,solutiondetail:20,solutioninfo:[20,24,41],solutionspec:[20,24,41],solutionsummari:23,solutionvers:23,some:[1,2,8,11,14,16,17,20,21,22,23,24,26,28,29,30,38,39,40,41,44,47,49,51,52,57,59,63,64,75,77,83,87,97,98],someth:91,sometim:1,soon:[1,2],sooner:[2,11],sort:23,sortabl:14,sourc:[1,2,3,11,15,17,20,23,24,26,41,46,47,52,71,81,95,98,101,102],source_appli:52,source_endpoint:17,source_id:15,source_info:[15,52,102],source_librari:15,source_library_item_id:15,source_loc:52,source_svc:102,source_typ:[2,17,23,24,41],source_vc_window:52,source_vm:52,sourceappliancespec:52,sourcecreatespec:46,sourceinfo:[15,46,52],sourcetyp:[2,17,23,24,41,46,95,102],sourcevcwindow:52,sp:20,space:[1,2,4,11,52,61,65,97,98],spars:52,spbm:[52,100],spec:[1,2,4,5,6,8,11,12,15,20,21,23,24,26,28,29,33,35,41,44,52,54,61,64,65,66,67,68,69,70,71,75,77,80,87,89,90,91,92,93,95,96,97,98,99,101,102],specfic:[24,41],special:[2,4,11,102],special_char:11,specif:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,29,31,33,34,35,36,37,39,40,41,42,43,44,45,46,47,51,52,55,57,59,61,62,64,65,74,75,77,78,79,80,81,82,87,89,92,95,96,97,98,99,101],specifi:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,23,24,25,26,27,28,29,31,33,34,35,36,39,40,41,42,43,44,46,47,48,51,52,54,55,57,62,63,64,65,70,75,77,78,80,81,83,84,87,89,91,93,95,96,97,98,99,100,101,102],specified_base_image_recommend:24,specified_base_image_version_recommend:24,speed:1,split:52,spsstorageprofil:[52,64,77],squar:1,ss:[11,46],ssh:[2,4,11,51,52],ssh_thumbprint:52,ssh_verifi:52,sshverifi:52,ssid:[20,28],ssl:[1,15,16,20,23,51,52,54,96],ssl_certificate_thumbprint:16,ssl_thumb_print:[20,23],ssl_thumbprint:[1,15,20,52],ssl_verifi:52,sslcertif:[1,15,16,20,23],sslcertificatethumbprint:16,sslthumbprint:[1,15,20,23,52],sslverifi:52,sso:[1,2,4,15,51,52,72,97],sso_admin_password:52,sso_admin_user_nam:[2,4],sso_admin_user_password:[2,4],sso_admin_usernam:52,sso_domain:52,sso_domain_nam:52,sso_login_requir:2,sso_password:1,sso_site_nam:52,sso_us:1,sssz:46,ssupervisor:52,st:[1,17,51,52,87],stabil:13,stabl:[52,81],stack:[51,52],stage:[1,2,11,16,20,23,52,77],stage_and_instal:2,stage_in_progress:1,stage_statu:20,stage_task:23,stageresult:23,stagespec:23,stagestatu:[20,23],staging_complet:2,stai:[1,16,17],stamp:1,stand:[12,52],standalon:[1,23,24,41,43,51,52,69],standalone_host:12,standalonepscspec:[52,69],standalonespec:52,standard:[1,11,12,15,16,45,46,51,52,97],standard_portgroup:[1,52,97],standbi:[1,52,97],standlon:[23,41,42,43,44],start:[1,2,4,5,8,12,13,14,15,17,18,20,23,24,26,28,39,40,43,47,52,54,64,65,77,97,98,99],start_connect:[18,97],start_index:98,start_minim:97,start_tim:[1,2,4,5,8,14,20,23,24,26,28,43,52,97],start_timestamp:5,starting_address:52,startingaddress:52,starttim:24,starttimeout:[1,2,52],startup:[1,2,52],startup_typ:[2,52],startuptyp:[1,2,52],stat:[1,52,77],stat_id:1,stat_summari:52,state:[1,2,3,4,6,8,11,12,13,14,16,17,20,23,24,26,27,28,29,30,32,33,34,35,36,41,42,43,44,47,51,52,54,55,65,68,69,77,87,89,90,91,92,95,96,97,98,99,101],state_or_provinc:54,stateful_set_count:52,stateful_set_count_unset:52,statefulset:52,statefulsetcount:52,stateless:[3,11,24,41,97,98],statement:47,static_ippool:52,static_manu:52,staticrang:52,statist:[1,52,77],stats_client:[0,1,52,103],statu:[1,2,3,4,5,8,11,13,14,15,16,17,20,21,23,24,26,28,31,41,43,46,52,55,63,64,65,66,67,71,77,83,84,86,87,88,90,91,92,93,95,97,98,100],status:[1,3,20,24,52,83,84,98],status_avail:52,statusinfo:[20,24],statustyp:[8,24,41],stau:31,std:[0,1,2,3,4,5,6,8,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,48,49,50,52,53,54,55,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,103],std_client:[0,1,2,4,5,8,14,16,17,20,21,23,24,28,41,43,51,52,64,65,66,67,77,79,87,90,91,92,93,95,96,97,100,103],stdio:97,stdlib:[1,2,8,21,23,24,26,28,41,75,87,90,91,92,93,94,95],step:[1,14,24,26,28,43,52],still:[1,2,13,15,20,23,52,75,77,97],stop:[1,2,3,13,23,52,64,77],storag:[0,1,2,12,13,15,16,17,18,19,28,31,51,52,64,65,77,97,101,103],storage1:1,storage_back:[1,15,16],storage_capac:[52,77],storage_cli:[0,1,103],storage_device_compli:28,storage_device_info:28,storage_device_overrides_cli:[20,23,24,28,30],storage_drs_config:12,storage_group:52,storage_map:52,storage_pod:11,storage_polici:[1,18,52,77,97],storage_policy_group:18,storage_profil:52,storage_profile_id:52,storage_provis:52,storage_request_limit:52,storage_request_limit_unset:52,storage_spec:52,storage_tot:1,storage_uri:[15,16],storage_us:[52,77],storageback:[1,15,16,17],storagechang:2,storagedevicecompat:28,storagedevicecompli:28,storagedevicecomplianceinfo:28,storagedeviceconstraint:28,storagedeviceinfo:28,storagedrsconfiginfo:12,storagedrspodconfiginfo:12,storagegroupmap:52,storagegroupsect:52,storagehclconstraint:28,storageinfo:64,storagemap:2,storageplacementspec:1,storagepod:[11,12,52],storagepolici:[1,18,19,52,83,97,100],storagepolicygroup:[18,19],storagepolicyspec:[1,97],storageprofil:52,storagesect:52,storagespec:[52,64],storagevmreact:13,store:[1,13,15,16,24,41,47,52,54,61,65,77,81,87,89,95,96,97,101],str:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,72,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],stream:[16,52],string:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,27,28,31,33,34,35,36,37,39,40,41,42,43,45,46,47,51,52,54,55,64,65,66,67,71,75,76,77,78,81,83,84,87,89,90,91,92,93,95,96,97,98,99,100,102],string_list:47,string_valu:47,stroag:31,strong:1,strongli:15,struct:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],structur:[1,2,3,4,5,11,18,23,24,25,26,31,45,46,47,49,51,52,55,77,89,95,96],structure_id:47,structure_refer:47,structure_reference_list:47,structureinfo:47,sts_group:52,sts_user:52,stsprincip:[52,87],stsprincipalid:52,stsprincipaltyp:52,stub:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],stub_config:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],stubconfigur:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],stubfactori:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],stubfactorybas:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],stuck:[13,97],style:[46,47],sub:[18,20,23,80],sub_class_cod:20,sub_typ:18,subdirectori:98,subject:[1,3,11,12,13,17,52,54,77,97],subject_alt_nam:54,subject_alternative_nam:54,subject_dn:54,subject_token:52,subject_token_typ:52,subject_typ:52,subjectaltnam:54,subjecttyp:52,submodul:[0,7,85,103],subnet:[52,77,81],subnet_mask:52,subnet_prefix_length:52,subnetmask:52,subpackag:103,subscrib:[1,14,15,16,52,77,101],subscribed_librari:15,subscribed_library_loc:15,subscribed_library_nam:15,subscribed_library_plac:15,subscribed_library_vcent:15,subscribed_library_vcenter_hostnam:15,subscribeditem:15,subscribedlibrari:[1,15],subscribedlibraryloc:15,subscribedlibraryplac:15,subscript:[1,14,15],subscription_info:1,subscription_url:[1,15],subscriptioninfo:[1,15],subsequ:[1,2,23,51,52],subset:[28,31,63,95],substitut:46,substr:[39,40],subsystem:[1,2,20,99],subtask:[1,20],subtask_ord:1,subtaskinfo:1,subtyp:18,succe:[24,51,52,98],succeed:[1,2,4,5,8,14,17,20,52,63,97],succes:17,success:[1,2,3,8,14,20,23,24,26,28,43,46,52,63,68,69,75,76,77,96,98],success_apply_initi:26,successful_host:[23,24,28],successfulli:[4,8,12,14,23,24,26,28,41,43,51,52,63,74,77,81,91,92,97,99],sucess:28,sucessful:24,sucessfulli:24,suffici:[1,13,52],suffix:[52,98],suggest:[52,66,75],suitabl:[1,15,52,54,97,101],sum:[1,15,52,64,77],summar:[24,47,88,90,91,92],summari:[1,2,5,11,12,15,16,23,24,28,37,41,43,47,52,54,55,64,65,66,67,75,77,78,79,80,82,83,87,88,89,90,91,92,93,95,97,98,99,101],summary_result:28,summary_typ:87,summarytyp:87,summaryv2:52,sun:52,sundai:[2,4,11,23,64],superadmin:1,superced:52,supervisor:[0,1,52,64,77,78,103],supervisor_primary_workload_network:52,supervisor_servic:[52,64,77],supervisor_services_cli:[0,1,52,103],supervisors_cli:[0,1,52,103],supervisorservic:[52,64,77],suport:52,suppli:[1,20,24,52,65,75,77,78],support:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,23,24,26,27,28,29,31,33,34,35,36,37,39,40,41,42,43,45,46,47,51,52,54,55,56,57,59,61,63,64,65,66,67,71,72,74,75,76,77,78,81,83,84,87,89,90,91,92,95,96,97,98,99,100,102],support_bundle_cli:[0,1,103],supportbundl:[1,52],supportbundle_cli:[0,1,103],supportbundle_oper:1,supportbundlecompon:2,supported_allocation_schem:52,supported_featur:28,supported_firmware_vers:28,supported_ip_allocation_polici:52,supported_ip_protocol:52,supported_new:52,supported_old:52,supported_releas:[21,39,40],supported_rul:1,supportedfeatur:28,suppos:[24,41],suppress:[28,31],suppress_warn:31,sure:77,surfac:52,suse:52,suse_64:52,suspend:[24,27,33,34,35,36,41,42,51,52,97,98,99],suspend_vm:[24,27,33,34,35,36,41,42],suspend_vms_to_memori:[24,27,33,34,35,36,41,42],svid:[20,28],svr:98,swap:[2,3],sx:52,symbol:[97,98],symlink:98,symlink_target:98,symmetr:89,sync:[1,11,15,16,20,23,37,52,77,81],sync_optional_fil:15,sync_task:20,synchron:[1,11,15,52,77],synclibrari:1,synclibraryitem:15,syncschedul:23,syntax:[51,52],syslog:11,sysprep:52,sysprep_xml:52,sysprepxml:52,system32:97,system:[0,1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,22,23,24,25,26,27,28,29,30,34,36,38,39,40,41,42,43,44,47,51,52,54,55,61,62,63,64,65,72,75,77,78,79,80,82,83,84,86,87,91,93,95,96,97,98,99,100,101,102,103],system_bio:20,system_cli:[0,1,103],system_config:[0,1,52,103],system_config_cli:[0,1,103],system_defin:23,system_nam:[4,5],system_name_cli:[0,1,2,4,103],system_servic:8,systemnam:4,systemtimestruct:2,t0_gatewai:78,t:[1,2,4,8,13,16,17,20,23,24,28,31,41,46,47,51,52,55,62,63,75,77,78,81,83,87,91,97,98,99],tabl:47,tag:[1,14,15,24,47,51,52,55,57,59,60],tag_id:14,tag_nam:55,tag_typ:55,tagassoci:14,tagging_cli:[0,1,103],tagmodel:14,tagtoobject:14,tagtyp:55,tagusag:55,tailor:52,take:[1,2,13,41,42,46,51,52,54,64,75,77,97],taken:[1,2,5,13,21,24,27,31,33,34,35,36,41,42,52,75,77],tanzu:[52,77,78],tar:52,target:[1,2,4,5,8,14,15,16,20,21,23,24,28,51,52,75,76,97,98],target_product:75,target_releas:21,target_sourc:20,target_vers:75,targetvers:75,task:[1,2,4,5,8,14,15,20,21,23,24,25,26,27,28,33,34,35,36,41,42,51,52,75,87,90,91,92,93,94,95,97],task_client:[0,1,2,5,8,20,23,24,28,52,103],task_id:24,taskid:24,taskinfo:[1,2,8,20],tbd:52,tcg:89,tcp:[2,11],tear:52,tebi:1,tech:86,tech_preview:86,tech_preview_cli:[0,1,52,85,103],technet:52,technolog:[1,8,11,57,59],tell:47,temperatur:1,templat:[1,12,15,18,46,52,97,101],template_library_item:[52,101],temporari:[16,98],temporarili:77,tenanc:52,tenant:[74,80],tenants_cli:[0,1,52,73,103],tent:[3,11,98],tera:1,term:[1,2,15,23,24,31,52,87,88,89,92,95,97,98],termin:[1,13,16,47,52,97,98],test:[1,2,3,8,11,57,59],testresult:2,testrunstatu:1,teststatu:3,teststatusinfo:3,text:[1,2,4,45,47,52],tgz:92,tha:52,than:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,22,23,24,27,28,34,41,45,47,51,52,54,63,76,83,84,91,96,97,98,99,100],theattribut:[51,52],thei:[1,2,11,12,13,14,15,17,23,46,47,51,52,54,57,76,77,78,87,97],them:[1,8,11,20,47,51,52,57,59,62,77,95,97],therebi:17,therefor:1,thereof:11,thi:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,49,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],thick:52,thin:[1,52],thin_provisioning_support:1,third:[46,54,77,94],thirti:1,those:[1,2,11,13,14,15,16,24,40,45,51,52,63,75,93,97],though:[1,13],three:[47,52,54],three_month:24,threshold:[11,13,64,71],through:[1,2,3,11,15,16,24,26,52,65,75,97,98],thrown:[1,14,23,31,52,77],thu:[1,2,14,15,26,52,95],thumbprint:[1,15,16,20,23,52,54,70],thumbprint_verif:1,thumbprintverif:1,thursdai:[2,4,11,23,64],thw:52,ti:52,ticket:[20,23,97],tier0:52,tier0_gatewai:52,tier:78,till:[17,52],time:[1,2,4,5,6,8,11,13,14,15,16,17,18,20,21,23,24,26,27,28,33,34,35,36,41,42,43,46,47,51,52,64,65,66,74,75,77,78,89,91,92,94,97,98,99,100,101],time_cli:[0,1,2,103],time_dur:24,time_period:24,time_stamp:77,time_sync:11,time_zon:[11,52],timed_out:[1,8,23,24,28,43,51],timedout:[1,2,20,23,24,51,52],timedur:24,timefram:24,timeout:[1,2,11,13,16,20,23,28,43,51,52,71,90],timeout_m:52,timeperiod:24,timeseri:77,timestamp:[1,2,4,5,24,41,46,52,77],timesync:[1,11],timesyncmod:[1,11],timezon:[2,6,11,47],tini:[52,77],tip:52,tkg:52,tl:[1,2,11,52,54,77,81,87,93,95],tls_endpoint_certif:52,tls_management_endpoint_certif:52,tls_root_ca_bundl:[52,81],tlscsr:54,tme:52,todai:14,todo:20,togeth:[11,47,82],toggl:15,token:[1,11,15,16,20,45,46,47,51,52,54,64,66,74,80,87,97,98],token_deleg:11,token_endpoint:52,token_exchange_gr:[1,52],token_polici:11,token_renew:11,token_typ:[1,52,74],tokenexchang:52,tokeninfo:[1,52,74],tokenpolici:11,tokenservic:52,tokenservice_cli:[0,1,103],toler:[11,13,51,52,97],too:[51,52,88,89,97,98],too_new:52,too_old_unsupport:52,took:5,tool:[1,11,13,51,52,97,98],tools_client:[0,1,52,103],toolsinstalltyp:52,top:[3,20,24,47,51,52,75],topic:52,topolog:[52,77,78],topology_cli:[0,1,103],total:[14,23,52,64,77,97,98],tpm2:91,tpm2_client:[0,1,52,87,90],tpm2_import:89,tpm2_policypcr:89,tpm2_readpubl:89,tpm2_unseal:89,tpm2b_digest:89,tpm2b_encrypted_secret:89,tpm2b_name:89,tpm2b_privat:89,tpm2b_public:89,tpm:[66,88,89,91],tpm_client:[0,1,52,87,88],tpm_requir:66,tpml_pcr_select:89,track:[15,16,17,52],tracking_sn:1,traffic:[1,3,52,77,78,81,97],transfer:[1,5,16,17,52,97,98],transferendpoint:[16,17],transferstatu:[16,17],transform:52,transient_ippool:52,transientind:[51,52],transit:[17,24,26,52,77,96],transition_en:24,translat:[16,47,52,78],transmit:16,transport:[2,11,51],treat:[15,31],tree:47,tri:24,triag:20,trial:66,trigger:[1,15,51,52,65],truncat:[16,39,40,52,89],trust:[1,16,17,51,52,54,67,77,80,87,88,89,90,91,92,93,95],trust_author:67,trust_authority_clust:[0,1,52,87,95,103],trust_authority_clusters_cli:[0,1,52,103],trust_authority_hosts_cli:[0,1,52,103],trust_verifi:77,trustauthorityclust:[52,87,95],trusted_ca:[87,95],trusted_clust:[0,1,52,87,103],trusted_clusters_cli:[0,1,52,103],trusted_infrastructur:[0,1,52,103],trusted_infrastructure_cli:[0,1,87,89,90,91,95,103],trusted_provid:77,trustedadmin:[52,87,95],trustedc_a:95,trustedcertif:1,trustedpeercertif:93,trustedrootchain:54,trustmanag:74,truststor:1,trustworthi:[51,93],truth:[1,95],ts:1,tss:77,tty1:[2,11],tty2:[2,11],tuesdai:[2,4,11,23,64],turbo_linux:52,turbo_linux_64:52,turbolinux:52,turn:[1,13,15,52,97],two:[1,13,47,51,52,54,99,102],type:[0,1,2,3,4,5,6,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,103],typeintrospect:1,typic:[1,11,12,20,46,51,52,91],tz:52,u1:52,u2:52,u3:[31,54],ubuntu:52,ubuntu_64:52,udp:[2,11],ui:[11,20,23,28,52,54,64,80],ui_access_url:64,ui_opt:52,uid:98,uioption:52,umd:[20,23,38],umds_client:[0,1,20,23,103],un:52,unabl:[1,8,24,46,51,52,77,83,84,97,99,100],unable_to_allocate_resourc:51,unabletoallocateresourc:[1,2,51,52,83,84,95,97,98,99,101],unattend:52,unattendedjoin:52,unauthent:[1,2,8,14,15,16,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,51,52,53,61,62,63,64,65,66,67,68,69,70,71,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,97,98,99,100,101],unauthor:[1,2,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,51,52,53,54,55,62,63,64,65,66,67,71,72,74,77,78,79,80,82,83,84,87,88,89,95,96,97,98,99,100,101],unavai:2,unavail:[1,8,17,20,24,28,51,52,77,97],unavailable_data_processing_unit:20,unavailable_host:20,unc:15,unchang:[1,2,6,15,52,66,80,90,91,97,99],uncondit:1,unconfigur:[3,11,52],undefin:[1,52,63,93],undeploi:52,undeploy_task:52,undeployspec:52,under:[1,4,28,52,98],undergo:51,underli:[1,16,17,98],underscor:47,understand:[1,8,16,20,23,45,52,74],unencrypt:[54,66],unest:28,unexpect:[51,52,62,63],unexpected_input:51,unexpectedinput:51,unexpectedli:52,unhealthi:[2,52],unicast:98,unicod:[46,47],uninterrupt:77,union:[24,51],union_cas:47,union_case_without_union_tag:24,union_tag:47,unioncas:47,uniontag:47,uniqu:[1,3,11,13,14,15,16,20,46,47,51,52,54,55,57,59,60,64,66,75,77,78,80,81,87,88,89,90,91,92,95,97,98],unit:[1,11,12,15,20,23,54,76,97],unitsfactor:1,univers:[1,15,16,64,97],unix:[1,77],unix_tim:77,unixwar:52,unixware_7:52,unknown:[1,2,3,8,11,13,15,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,51,52,55,75,77,83,87,95,97,98,102],unknown_compli:[84,100],unknown_devic:28,unknown_error:1,unknown_sect:52,unknownsect:52,unknownsectionparam:52,unless:[1,2,13,16,17,52,77,78],unlik:[13,16],unlink:52,unlock:11,unlock_tim:11,unmanag:52,unmodifi:52,unmount:52,unprepar:17,unprocess:1,unpublish:15,unqiu:87,unreach:[1,2],unrecover:97,unrecoverable_error:97,unregist:[1,98],unreserv:[1,11,12],unrestrict:52,unseal:89,unsealspec:89,unset:[1,13,15,16,23,24,31,33,35,41,52,54,77,78,81,87,88,89,90,92,95,96,98],unset_certificate_authority_data:80,unset_groups_claim:80,unset_security_policy_id:1,unset_username_claim:80,unspecifi:[1,2,15,23,24,28,43,51,52,97],unsubscrib:14,unsupport:[1,21,23,41,42,43,44,45,51,52,54,61,64,66,77,80,84,97,98,99],until:[4,13,16,17,31,47,52,54,71,83,84,93,99,100],untrust:[16,93],untrusted_certif:[17,52],unus:[15,81],unverified_p:51,unverifiedp:[20,23,51,52,96],unwil:52,up:[1,2,4,11,13,15,16,17,26,52,66,78,97,98],up_to_d:1,updat:[1,2,3,4,6,11,12,13,14,15,16,17,20,23,24,28,29,31,39,40,41,44,47,52,66,72,75,77,78,80,81,87,90,91,93,95,97,98,99,101],update2:2,update_cli:[0,1,52,103],update_count:75,update_resource_quota_typ:52,update_session_id:[16,17],update_spec:[1,14,15,16,31],update_task:[20,31,52,87,90,91,93,95],update_tim:65,update_typ:[2,75],update_v2:52,updateconfig:1,updateconfigur:1,updated_at:20,updated_since_last_check:28,updatedai:11,updatelibrari:1,updatelibraryitem:15,updatelocallibrari:1,updateresourcequotatyp:52,updates_pend:1,updatesess:[15,16,17],updatesession_cli:[0,1,15,16,103],updatesessionmodel:[16,17],updatespec:[1,2,4,6,14,15,23,24,29,31,44,52,66,75,80,90,91,93,97,99],updatespecplac:15,updatespecvcent:15,updatesubscribedlibrari:1,updatesubscript:15,updatesummari:23,updatetim:65,updatetyp:75,upgrad:[2,20,51,52,75,76,77],upgrade_at_power_cycl:52,upgrade_count:75,upgrade_error:52,upgrade_multipl:77,upgrade_polici:52,upgrade_progress:52,upgrade_statu:[52,77],upgrade_vers:52,upgradepolici:52,upgradeprogress:77,upgradespec:[52,77],upgradestatu:[52,77],uplink:81,upload:[1,11,15,16,17,23,24,41],upload_endpoint:17,upn:52,upn_claim:52,upon:[2,11,15,17,52,64,65,77],uppercas:[2,4,11],uppercase_char:11,upstream:80,upt:97,upt_compatibility_en:97,uptim:2,urgenc:[23,37],urgencytyp:[23,37],uri:[1,15,16,17,20,45,47,52,54,75,89,97],url:[1,2,4,5,11,15,16,17,20,23,24,41,51,52,64,65,66,75,80,89,98],urn:[1,52],us:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,57,59,60,61,62,63,64,65,66,67,68,69,70,71,72,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102],usabl:[1,52,97],usag:[1,11,12,47,51,52,54,56,57,59,72,77],usb:[18,99],usb_control:18,usbcontrol:18,usbcontrollertyp:18,use_auto_detect:18,use_cluster_default:13,use_default_polici:97,use_dhcp:52,use_exist:15,use_source_polici:52,use_specified_polici:[52,97],useclusterdefault:13,used_bi:14,used_by_ent:14,used_by_vsan:[20,28],used_for_compli:28,user:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,23,24,26,28,31,40,41,46,47,51,52,53,55,61,62,63,64,65,68,72,75,77,78,79,80,82,83,84,87,95,96,97,98,99,100,101],user_account_set:11,user_cli:[0,1,52,103],user_cr:13,user_data:[2,52],user_defin:47,user_defined_typ:47,user_flag:28,user_info:1,user_input_requir:52,user_nam:[1,15,20,23,52,97],user_overrid:28,user_pass:[46,47],user_password:46,user_select:28,user_selected_d:13,user_verifi:28,useraccountset:11,userdata:52,userdefinedtyp:47,userinfo:1,usernam:[1,2,4,5,11,15,20,23,24,46,47,51,52,68,78,80,81,82,90,97],username_claim:80,username_password:[20,23,97],usernameclaim:80,users_base_dn:52,usr:97,usual:[1,13,46,52],utc:[1,47],utf8:47,utf:[47,52],util:[1,11,12,45,52,64,74,76],uuid:[1,15,16,23,24,51,52,64,66,77,78,79,91,97],v1:[0,1,2,7,8,52],v1_client:[0,1,2,7,103],v2:52,v3:1,v42:[20,39,40],v4:1,v:52,v_san_data_onli:28,val:1,valid:[1,2,3,4,8,11,13,14,15,16,17,19,20,21,23,24,26,27,28,30,31,33,34,41,46,47,51,52,54,61,68,69,84,87,91,93,95,96,97,98,99],valid_from:54,valid_to:54,valid_with_warn:52,validaiton:28,validate_config_task:26,validate_task:[2,23,24,41],validated_features_in_us:[28,31],validateresult:[24,26,41],validation_error:[24,52],validationdetail:24,validationerror:[17,24,26],validationresult:[2,17,24],validationstatu:[2,52],validfrom:54,validto:54,valu:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,54,55,57,59,60,61,62,63,64,65,66,67,69,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,95,96,97,98,99,100,101,102],value_illeg:52,vami:75,vapi:[0,1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103],vapi_cli:[0,103],vapierror:[45,51,52],vapiinterfac:[1,2,3,4,5,6,8,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,47,48,49,50,52,53,54,55,61,62,63,64,65,66,67,68,69,70,71,72,74,75,77,78,79,80,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],vapistruct:[1,2,3,4,5,6,8,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],vapp:[18,52],vapp_nam:18,vapp_templ:18,vapptempl:18,vari:[11,13],variabl:[2,11,47,52,97,102],variable_disk_s:52,variant:[52,98],variou:[1,2,16,24,25,41,47,52,77],vc:[2,11,20,23,52,54,61,76,77],vc_group:11,vc_inherit:[52,81],vc_spec:[52,96],vcdb:[2,4,5],vcenter:[0,1,2,4,15,16,20,21,23,24,41,51,103],vcenter_cli:[0,52,103],vcenter_servic:8,vcenterextensionparam:52,vcenterfqdn:[23,24,41],vcenterinfo:15,vcenterserv:1,vcg:[20,28,31],vcg_link:21,vcg_product:[28,31],vcgentri:31,vcgroup:11,vcha:[0,1,52,103],vcha_client:[0,1,96,103],vcident:52,vcidentityprovid:[52,74],vcintegr:[20,21,22,23,24,25,26,27,28,29,30,33,34,35,36,37,38,39,40,41,42,43,44],vcl:60,vcpu:1,vcsa:[2,52,54,75],vcsa_embed:52,vcsa_extern:[52,68],vcsaembeddedspec:52,vcserver:[52,96],vcsp:15,vcva:52,vd:[77,78],vec:[52,54,81],veloc:1,vendor:[1,20,23,28,31,37,38,52,78],vendor_id:52,vendor_upd:28,verb:47,verbos:87,verif:[1,15,16,52],verifi:[1,3,8,11,15,16,17,24,26,41,51,52,54,61,77,78,81,91,97,98],verification_failur:16,verification_in_progress:16,verificationmod:52,versa:52,version1:51,version2:51,version:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,22,23,24,26,27,28,29,31,33,34,35,36,37,39,40,41,42,43,44,45,46,47,51,52,54,55,64,65,66,67,71,75,76,77,78,81,83,84,87,88,89,90,91,92,95,96,97,98,99,100,101,102],version_nam:5,version_numb:52,version_spec:52,version_statu:52,versionstatu:[52,97],versionstruct:2,verson:52,vff:1,vgpu:52,vgpu_devic:52,vgpudevic:52,vi:1,via:[1,24,41,46,52,77,81],vib:[24,41],vice:52,vid:[20,28],video:18,video_card:18,video_ram_s:18,videocard:18,view:[11,14,18,23,24,25,26,52,54,87,95,97],vim:[13,52,78,79],violat:51,virtual:[1,2,11,12,13,15,18,19,51,52,54,57,58,59,60,76,78,81,83,84,96,97,98,99,100,101],virtual_machin:[1,52],virtual_machine_autom:[11,13],virtual_system_id:52,virtualapp:52,virtualcent:[1,11,12,13,52],virtualdevic:52,virtualdisk:97,virtualdiskmap:97,virtualhardwar:12,virtualhardwaresect:52,virtualmachin:[1,12,52,57,59,60,83,84,97,98,99,100,101],virtualmachineclass:52,virtualmachineconfig:12,virtualmachineconfigspec:52,visibl:[1,2,4,11,15,16,17,23,52],vista:52,visual:1,vitrual:18,vlcm:[23,38,41,42,43,44],vm:[0,1,11,12,13,14,18,24,27,33,34,35,36,41,42,51,52,55,56,57,76,77,78,83,84,101,103],vm_additional_delai:13,vm_affinity_rul:13,vm_and_app_monitor:13,vm_anti_affinity_rul:13,vm_apd_failover_delai:13,vm_apd_failure_respons:13,vm_apd_response_recoveri:13,vm_capabl:57,vm_class:52,vm_client:[0,1,7,8,9,10,11,97,103],vm_config_spec:52,vm_count:18,vm_datastore_with_pdl_failure_respons:13,vm_folder:1,vm_group:13,vm_group_nam:13,vm_home:[83,84,97,100],vm_home_storag:52,vm_host_affin:57,vm_host_affinity_cli:[0,1,52,55,56],vm_host_anti_affin:57,vm_host_anti_affinity_cli:[0,1,52,55,56],vm_host_rul:13,vm_isolation_respons:13,vm_monitor:13,vm_monitoring_dis:13,vm_monitoring_onli:13,vm_name:[18,52],vm_restart_prior:13,vm_restart_priority_timeout:13,vm_service_spec:52,vm_tag:[57,59,60],vm_templat:[0,1,18,52,103],vm_template_cli:[0,1,103],vm_tools_monitoring_set:13,vm_type:11,vm_vm_affin:57,vm_vm_affinity_cli:[0,1,52,55,56],vm_vm_anti_affin:57,vm_vm_anti_affinity_cli:[0,1,52,55,56],vmca:54,vmcaroot:54,vmcomplianceinfo:100,vmconfigspec:52,vmconfigspecprovid:52,vmdk:[77,97],vmdk_file:97,vmdkcreatespec:97,vmdpu0:22,vmdpu1:22,vmf:[1,12,15,16,51],vmgroup:13,vmgroupnam:13,vmhome:[83,100],vmhomepolicyspec:97,vmhomestorageinfo:52,vmhostrul:13,vmhotrul:13,vminfo:52,vmkernel:52,vmkernel_5:52,vmkernel_65:52,vmkernel_6:52,vmkernel_7:52,vmkernel_8:52,vmmonitoringst:13,vmon:2,vmon_client:[0,1,103],vmotion:[12,57,59],vmotion_cli:[52,55,56,57,58],vmotionr:[11,13],vmoverrid:13,vmrc:97,vmreactiononapdclear:13,vmservicespec:52,vmtemplat:18,vmtool:13,vmtoolsmonitoringset:13,vmtx:52,vmw:52,vmware:[0,102,103],vmware_photon_64:52,vmx:[1,52],vmx_03:52,vmx_04:52,vmx_06:52,vmx_07:52,vmx_08:52,vmx_09:52,vmx_10:52,vmx_11:52,vmx_12:52,vmx_13:52,vmx_14:52,vmx_15:52,vmx_16:52,vmx_17:52,vmx_18:52,vmx_19:52,vmx_20:52,vmx_21:52,vmxnet2:97,vmxnet3:97,vmxnet:97,volt:1,voltamper:1,volum:[1,12,15,16,52,77],vpxd:52,vrf:52,vsan:[1,12,13,20,21,24,28,31,41,52,77,97],vsan_client:[8,9,10,11,12],vsan_clust:[52,77],vsan_witness_elig:[24,41],vsanconfiginfo:13,vservicedepend:52,vsphere:[1,2,3,4,5,6,11,12,13,14,15,16,17,20,22,23,24,25,26,27,28,31,33,34,35,36,38,39,40,41,42,43,44,46,47,51,52,53,54,60,61,62,63,64,65,66,67,68,69,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],vsphere_apps_check_result:52,vsphere_apps_yaml:77,vsphere_network:52,vsphere_spec:[52,77],vsphereappscheckresult:52,vspherecreatespec:[52,77],vspheredistributedportgroup:81,vspheredistributedswitch:[52,78,79,81],vspheredvpgnetworkcreatespec:52,vspheredvpgnetworkinfo:52,vspheredvpgnetworksetspec:52,vspheredvpgnetworkupdatespec:52,vsphereha:[12,13],vspherenetwork:81,vsphereuiconfigur:[8,11],vsphereuiconfiguration_cli:[2,7,8,9,10],vstat:1,vstats_client:[0,103],vswitch:51,vulner:[2,75],vum:[2,23,24,41],vum_remedi:[24,41],vvol:[1,97],wa:[1,2,3,4,5,6,8,11,14,15,16,17,20,21,22,23,24,25,26,27,28,31,33,34,35,36,38,41,42,43,44,45,46,47,51,52,53,54,61,62,63,64,65,66,67,68,69,70,71,74,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],wai:[1,23,47,51,52,97],wait:[12,13,17,24,26,27,33,34,35,36,41,42,51,52,97],waitfornodeupgrad:[52,77],waiting_for_transf:[16,17],wake:97,wake_on_lan_en:97,want:[1,14,16,17,20,47,51,52,81,102],warn:[1,2,4,5,8,11,13,16,17,20,23,24,28,43,52,57,59,64,66,67,75,77,87,90,91,92,96],warn_dai:[2,11],warn_days_before_password_expir:[1,11],warning_behavior:16,warning_count:75,warning_messag:52,warningbehavior:[16,17],warninginfo:52,warningmessag:52,warningtyp:[17,52],warrant:52,wasn:17,wast:[1,11,12,76],watch:97,watt:1,wcp:[52,77],wcp_support_bundle_token:52,we:[2,13,23,28,31,39,40,47,52],web:[1,2,45,52,97],webmk:97,wednesdai:[2,4,11,23,64],week:[1,4,11,23,64],weekdai:[2,11],weekli:[23,64],well:[1,2,13,15,17,18,20,24,39,40,47,51,52,62,66,71,75,80],were:[2,3,8,11,20,23,24,28,51,52,68,69,74,77,98],what:[1,2,15,20,23,24,27,28,33,34,35,36,41,42,43,47,51,52,77,97],when:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,23,24,25,26,27,28,29,31,33,34,35,36,37,38,39,40,41,42,43,44,46,47,51,52,54,55,57,59,60,61,62,63,64,65,66,67,68,69,71,75,76,77,78,79,80,81,82,83,84,87,88,89,90,91,92,93,95,97,98,99,100,101,102],whenev:[59,97,98],where:[1,2,8,11,13,15,17,20,21,23,24,28,41,52,54,72,75,97,98],wherea:52,whether:[1,2,4,5,8,11,12,13,14,15,16,17,18,20,23,24,26,28,41,47,51,52,66,68,69,75,77,79,83,87,90,91,92,93,95,97,98,101],which:[1,2,3,4,5,8,11,12,13,14,15,16,17,18,20,21,23,24,26,27,28,31,33,34,35,36,37,39,40,41,42,43,45,46,47,51,52,54,55,57,62,63,64,65,66,67,68,71,74,75,76,77,78,79,80,81,82,83,84,87,89,90,91,92,95,96,97,98,99,100,101,102],whichev:16,who:[1,2,5,8,14,16,17,20,24,52,98,101],whole:[91,95],whom:52,whose:[1,2,15,16,20,24,28,46,47,51,52,75,77,97],why:[1,2,4,5,8,14,17,20,23,24,41,51,52],wich:77,wide:[11,12,13,98],wiki:77,wikipedia:77,wil:52,wildcard:[31,39,40],willing:51,win:[52,98],win_2000_adv_serv:52,win_2000_pro:52,win_2000_serv:52,win_31:52,win_95:52,win_98:52,win_attribut:98,win_longhorn:52,win_longhorn_64:52,win_m:52,win_net_busi:52,win_net_datacent:52,win_net_datacenter_64:52,win_net_enterpris:52,win_net_enterprise_64:52,win_net_standard:52,win_net_standard_64:52,win_net_web:52,win_nt:52,win_vista:52,win_vista_64:52,win_xp_hom:52,win_xp_pro:52,win_xp_pro_64:52,window:[1,11,13,14,15,52,97,98],windows_11_64:52,windows_12_64:52,windows_7:52,windows_7_64:52,windows_7_server_64:52,windows_8:52,windows_8_64:52,windows_8_server_64:52,windows_9:52,windows_9_64:52,windows_9_server_64:52,windows_config:52,windows_hyperv:52,windows_server_2019:52,windows_server_2021:52,windows_server_2025:52,windowsconfigur:52,windowsfileattributescreatespec:98,windowsfileattributesinfo:98,windowsfileattributesupdatespec:98,windowsnetworkadapterset:52,windowssysprep:52,wins_serv:[52,98],wipe:52,wit:[20,24,41,52,96],within:[1,2,3,8,11,13,14,15,16,17,18,23,24,25,27,28,33,34,41,46,47,51,52,55,57,59,60,71,74,77,87,95,97,98,101],without:[1,2,13,14,15,16,29,31,44,51,52,63,66,83,84],witness_redeploy_op:52,witnessinfo:52,witnessspec:52,won:[16,17,52,81,87],word:[15,28,47,52,97,98],work:[1,8,14,15,16,20,21,24,29,41,44,52,61,77,97],workaround:97,worker:[52,77],worker_dn:52,worker_vm_info:52,workflow:[26,52,77],workgroup:52,working_directori:97,workload:[11,52,63,77,78,80,81,87],workload_cli:[0,1,52,77,80],workload_network:52,workload_networks_spec:52,workload_ntp_serv:52,workloadnetworksenablespec:52,workloadnetworksinfo:52,workloadsstorageconfig:[52,77],workspac:11,workstat:[52,97],worm:2,would:[1,2,14,15,20,23,24,28,31,33,35,39,40,41,47,51,52,54,75,97,102],wrap:89,writabl:52,write:[1,23,24,29,33,35,41,44,51,52,71],writeabl:98,wrong:51,ws:52,www:[3,11,23,51,52,97],x20:45,x23:45,x509:[17,52,54,78,93],x509certchain:[52,54,87,89,91,95],x5d:45,x64:52,x:[1,2,52,98,102],xeon:20,xhci:18,xlarg:52,xml:[23,47,51,52],xp:52,xx:1,xxx:98,xyz:[24,41,72],y:[1,2],yaml:[52,77],yaml_service_config:77,yamlserviceconfig:77,ye:[2,52],year:[1,24,54],yellow:[2,13],yes_no:52,yet:[1,2,8,17,20,51,52,77,93,97],yield:97,yield_on_pol:97,yobi:1,yocto:1,yotta:1,you:[1,2,3,4,5,8,11,12,13,14,15,16,17,20,21,22,23,24,25,26,27,28,29,30,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,49,51,52,53,54,55,62,63,64,65,66,67,71,74,75,76,77,78,80,81,83,84,87,88,89,90,91,92,95,96,97,98,99,100,101,102],your:[2,14,15,52,77,80,81,102],yyyi:46,z0:[1,52],z:[2,4,11,46,52,65],za:1,zebi:1,zepto:1,zero:[2,11,16,17,47,52,89,98],zetta:1,zip:23,zone:[0,1,6,11,52,62,77,78,103],zone_associations_cli:[0,1,52,103],zone_filt:52,zone_summari:52,zonecompatibilityinfo:52,zonefilterspec:52,zonesummari:52},titles:["com package","com.vmware package","com.vmware.appliance package","com.vmware.appliance.networking package","com.vmware.appliance.recovery package","com.vmware.appliance.recovery.backup package","com.vmware.appliance.system package","com.vmware.appliance.vcenter package","com.vmware.appliance.vcenter.settings package","com.vmware.appliance.vcenter.settings.v1 package","com.vmware.appliance.vcenter.settings.v1.config package","com.vmware.appliance.vcenter.settings.v1.config.components package","com.vmware.appliance.vcenter.settings.v1.config.components.inventory package","com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package","com.vmware.cis package","com.vmware.content package","com.vmware.content.library package","com.vmware.content.library.item package","com.vmware.content.type package","com.vmware.content.type.ovf package","com.vmware.esx package","com.vmware.esx.hcl package","com.vmware.esx.hosts package","com.vmware.esx.settings package","com.vmware.esx.settings.clusters package","com.vmware.esx.settings.clusters.configuration package","com.vmware.esx.settings.clusters.enablement package","com.vmware.esx.settings.clusters.policies package","com.vmware.esx.settings.clusters.software package","com.vmware.esx.settings.clusters.software.drafts package","com.vmware.esx.settings.clusters.software.reports package","com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package","com.vmware.esx.settings.defaults package","com.vmware.esx.settings.defaults.clusters package","com.vmware.esx.settings.defaults.clusters.policies package","com.vmware.esx.settings.defaults.hosts package","com.vmware.esx.settings.defaults.hosts.policies package","com.vmware.esx.settings.depot_content package","com.vmware.esx.settings.depots package","com.vmware.esx.settings.hardware_support package","com.vmware.esx.settings.hardware_support.managers package","com.vmware.esx.settings.hosts package","com.vmware.esx.settings.hosts.policies package","com.vmware.esx.settings.hosts.software package","com.vmware.esx.settings.hosts.software.drafts package","com.vmware.oauth2 package","com.vmware.vapi package","com.vmware.vapi.metadata package","com.vmware.vapi.metadata.authentication package","com.vmware.vapi.metadata.metamodel package","com.vmware.vapi.metadata.privilege package","com.vmware.vapi.std package","com.vmware.vcenter package","com.vmware.vcenter.authorization package","com.vmware.vcenter.certificate_management package","com.vmware.vcenter.compute package","com.vmware.vcenter.compute.policies package","com.vmware.vcenter.compute.policies.capabilities package","com.vmware.vcenter.compute.policies.capabilities.vm package","com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package","com.vmware.vcenter.compute.policies.capabilities.vm.placement package","com.vmware.vcenter.confidential_computing package","com.vmware.vcenter.consumption_domains package","com.vmware.vcenter.consumption_domains.zones package","com.vmware.vcenter.content package","com.vmware.vcenter.content.registries package","com.vmware.vcenter.crypto_manager package","com.vmware.vcenter.crypto_manager.hosts package","com.vmware.vcenter.deployment package","com.vmware.vcenter.deployment.install package","com.vmware.vcenter.deployment.install.initial_config package","com.vmware.vcenter.host package","com.vmware.vcenter.hvc package","com.vmware.vcenter.identity package","com.vmware.vcenter.identity.broker package","com.vmware.vcenter.lcm package","com.vmware.vcenter.lcm.deployment package","com.vmware.vcenter.namespace_management package","com.vmware.vcenter.namespace_management.networks package","com.vmware.vcenter.namespace_management.networks.nsx package","com.vmware.vcenter.namespace_management.supervisors package","com.vmware.vcenter.namespace_management.supervisors.networks package","com.vmware.vcenter.namespaces package","com.vmware.vcenter.storage package","com.vmware.vcenter.storage.policies package","com.vmware.vcenter.system_config package","com.vmware.vcenter.system_config.features package","com.vmware.vcenter.trusted_infrastructure package","com.vmware.vcenter.trusted_infrastructure.hosts package","com.vmware.vcenter.trusted_infrastructure.hosts.hardware package","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package","com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package","com.vmware.vcenter.trusted_infrastructure.trusted_clusters package","com.vmware.vcenter.vcha package","com.vmware.vcenter.vm package","com.vmware.vcenter.vm.guest package","com.vmware.vcenter.vm.hardware package","com.vmware.vcenter.vm.storage package","com.vmware.vcenter.vm_template package","Interface definition language to python mapping for enumerated types","Welcome to vSphere Automation SDK for Python.\u2019s documentation!"],titleterms:{"default":[32,33,34,35,36],access_cli:2,adapter_cli:99,add_ons_cli:37,an:102,anti_affinity_with_vcls_cli:60,applianc:[2,3,4,5,6,7,8,9,10,11,12,13],appliance_cli:1,applmgmt_client:11,apply_cli:[27,34,36,42],attest:[91,92],attestation_cli:[87,90,95],authcommon_cli:11,authent:48,authentication_cli:[47,52],authmanagement_cli:11,author:53,authorization_cli:52,autom:103,backup:5,backup_cli:4,base_images_cli:37,boot_client:99,broker:74,broker_cli:73,capabilities_cli:56,capabl:[57,58,59,60],certificate_manag:54,certificate_management_cli:52,ci:14,cis_client:1,cli_client:47,client_certificate_cli:94,cluster:[13,24,25,26,27,28,29,30,31,33,34],cluster_cli:[12,63,96],cluster_scale_in_ignore_vm_capabilities_cli:57,clusters_cli:[23,32,77],cns_client:77,code:102,com:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],common_cli:[12,76],compliance_cli:84,compon:[11,12,13],components_cli:[10,37],comput:[55,56,57,58,59,60],compute_cli:[52,97],confidential_comput:61,config:[10,11,12,13],config_cli:9,configur:25,configuration_cli:[24,26],console_cli:97,consumption_domain:[62,63],consumption_domains_cli:52,content:[15,16,17,18,19,64,65,103],content_cli:1,crypto_manag:[66,67],crypto_manager_cli:52,data_sets_cli:97,datacenter_cli:12,datastore_cli:[12,52],defaults_cli:23,definit:102,deploy:[68,69,70,76],deployment_cli:[52,75],depot:38,depot_cont:37,depot_content_cli:23,depots_cli:23,disable_drs_vmotion_cli:57,discovery_cli:75,distributed_switches_cli:79,dns_client:3,document:[102,103],downloadsession_cli:17,draft:[29,44],drafts_client:[28,43],drs_client:13,edges_cli:[78,79],enabl:26,enablement_cli:[24,41],entropy_cli:71,enumer:102,errors_cli:[45,51],esx:[20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44],esx_client:92,evacu:59,evacuation_cli:58,exampl:102,featur:86,filesystem_cli:98,firewall_cli:3,folder_cli:12,guest:98,guest_client:[52,97],ha_client:13,harbor_cli:65,hardwar:[89,99],hardware_cli:[88,97],hardware_compat:31,hardware_compatibility_cli:30,hardware_support:[39,40],hardware_support_cli:23,hcl:21,hcl_client:20,health_client:2,host:[22,35,36,41,42,43,44,67,71,88,89],host_client:[12,52],hosts_client:[20,21,23,32,66,87],hvc:72,hvc_client:52,ident:[73,74],identity_cli:[52,80],indic:103,infraprofile_cli:2,initial_config:70,instal:[69,70],install_cli:68,interfac:102,interfaces_cli:3,inventori:[12,13],inventory_cli:[11,52],inventoryauthorization_cli:11,iso_cli:52,item:17,item_cli:16,job_client:5,km:[93,94],kms_client:[66,67,87,90,95],languag:102,lcm:[75,76],lcm_client:52,librari:[16,17],library_cli:15,library_items_cli:101,local_accounts_cli:2,localaccounts_cli:2,logging_cli:2,manag:40,management_cli:[72,81],managementcluster_cli:11,managers_cli:39,map:102,metadata:[47,48,49,50],metadata_cli:46,metamodel:49,metamodel_cli:47,migrate_cli:68,modul:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],monitoring_cli:2,namespac:82,namespace_manag:[77,78,79,80,81],namespace_management_cli:52,namespaces_cli:52,network:[3,78,79,81],network_cli:12,networking_cli:[2,98],networks_cli:77,nsx:79,nsx_client:78,ntp_client:2,oauth2:45,oauth2_client:1,offline_cli:38,online_cli:38,os:92,ovf:19,ovf_client:[18,52],packag:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],packages_cli:40,placement:60,placement_cli:58,polici:[27,34,36,42,56,57,58,59,60,84],policies_cli:[24,33,35,41,55,83],policy_cli:[19,100],privileg:50,privilege_checks_cli:53,privilege_cli:47,provid:94,providers_cli:93,psc_client:69,python:[102,103],reconciliation_cli:4,recoveri:[4,5],recovery_cli:2,registri:65,registries_cli:64,remote_psc_cli:70,report:[30,31],reports_cli:[25,28,43],resource_cli:49,resourcepool_cli:12,restore_cli:4,routing_cli:51,s:103,sdk:103,security_cli:6,service_cli:[48,49,50,78],services_cli:52,set:[8,9,10,11,12,13,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44],settings_cli:20,sgx_client:61,shutdown_cli:2,softwar:[28,29,30,31,43,44],software_cli:[22,24,29,41,44,77],stats_client:77,std:51,std_client:46,storag:[83,84,100],storage_cli:[52,77,97],storage_device_overrides_cli:31,submodul:[1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],subpackag:[0,1,2,4,7,8,9,10,11,12,15,16,18,20,23,24,28,30,32,33,35,39,41,43,46,47,52,55,56,57,58,62,64,66,68,69,73,75,77,78,80,83,85,87,88,90,91,93,97],supervisor:[80,81],supervisor_services_cli:77,supervisors_cli:77,support_bundle_cli:2,supportbundle_cli:2,system:6,system_cli:2,system_config:[85,86],system_config_cli:52,system_name_cli:5,tabl:103,tagging_cli:[14,52],task_client:14,tech_preview_cli:86,tenants_cli:74,time_cli:6,tokenservice_cli:52,tools_client:97,topology_cli:52,tpm2_client:91,tpm_client:89,trust_authority_clust:[90,91,92,93,94],trust_authority_clusters_cli:87,trust_authority_hosts_cli:87,trusted_clust:95,trusted_clusters_cli:87,trusted_infrastructur:[87,88,89,90,91,92,93,94,95],trusted_infrastructure_cli:52,type:[18,19,102],umds_client:38,update_cli:[2,75],updatesession_cli:17,user_cli:82,v1:[9,10,11,12,13],v1_client:8,vapi:[46,47,48,49,50,51],vapi_cli:1,vcenter:[7,8,9,10,11,12,13,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],vcenter_cli:[1,54],vcha:96,vcha_client:52,vm:[58,59,60,97,98,99,100],vm_client:[12,52],vm_host_affinity_cli:57,vm_host_anti_affinity_cli:57,vm_templat:101,vm_template_cli:52,vm_vm_affinity_cli:57,vm_vm_anti_affinity_cli:57,vmon_client:2,vmotion_cli:59,vmware:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],vsan_client:13,vsphere:103,vsphereuiconfiguration_cli:11,vstats_client:1,welcom:103,workload_cli:81,zone:63,zone_associations_cli:62}}) \ No newline at end of file